<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="dialogflow_v3beta1.html">Dialogflow API</a> . <a href="dialogflow_v3beta1.projects.html">projects</a> . <a href="dialogflow_v3beta1.projects.locations.html">locations</a> . <a href="dialogflow_v3beta1.projects.locations.agents.html">agents</a> . <a href="dialogflow_v3beta1.projects.locations.agents.playbooks.html">playbooks</a> . <a href="dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html">versions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a version for the specified Playbook.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified version of the Playbook.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the specified version of the Playbook.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists versions for the specified Playbook.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#restore">restore(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the specified version of the Playbook and stores it as the current playbook draft, returning the playbook with resources updated.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates a version for the specified Playbook.

Args:
  parent: string, Required. The playbook to create a version for. Format: `projects//locations//agents//playbooks/`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Playbook version is a snapshot of the playbook at certain timestamp.
  &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the playbook version.
  &quot;examples&quot;: [ # Output only. Snapshot of the examples belonging to the playbook when the playbook version is created.
    { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
      &quot;actions&quot;: [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
        { # Action performed by end user or Dialogflow agent in the conversation.
          &quot;agentUtterance&quot;: { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
            &quot;requireGeneration&quot;: True or False, # Optional. True if the agent utterance needs to be generated by the LLM. Only used in webhook response to differentiate from empty text. Revisit whether we need this field or mark `text` as optional when we expose webhook interface to customer.
            &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
          },
          &quot;completeTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the completion of the agent action.
          &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the action.
          &quot;event&quot;: { # Event represents the event sent by the customer. # Optional. The agent received an event from the customer or a system event is emitted.
            &quot;event&quot;: &quot;A String&quot;, # Required. Name of the event.
            &quot;text&quot;: &quot;A String&quot;, # Optional. Unstructured text payload of the event.
          },
          &quot;flowInvocation&quot;: { # Stores metadata of the invocation of a child CX flow. Flow invocation actions enter the child flow. # Optional. Action performed on behalf of the agent by invoking a CX flow.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
            &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
            &quot;flowState&quot;: &quot;A String&quot;, # Required. Flow invocation&#x27;s output state.
            &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the flow.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the flow invocation.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
          },
          &quot;flowStateUpdate&quot;: { # Stores metadata of the state update action, such as a state machine execution in flows. # Optional. Output only. The state machine update in flows.
            &quot;destination&quot;: &quot;A String&quot;, # The destination of the transition. Format: `projects//locations//agents//flows//pages/` or `projects//locations//agents//playbooks/`.
            &quot;eventType&quot;: &quot;A String&quot;, # The type of the event that triggered the state update.
            &quot;functionCall&quot;: { # Stores the metadata of a function call to execute. # The function call to execute.
              &quot;name&quot;: &quot;A String&quot;, # The name of the function call.
            },
            &quot;pageState&quot;: { # Stores the state of a page and its flow. # The updated page and flow state.
              &quot;displayName&quot;: &quot;A String&quot;, # The display name of the page.
              &quot;page&quot;: &quot;A String&quot;, # The ID of the page. Format: `projects//locations//agents//flows//pages/`.
              &quot;status&quot;: &quot;A String&quot;, # The status of the page.
            },
            &quot;updatedParameters&quot;: { # The updated parameters.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
          },
          &quot;flowTransition&quot;: { # Stores metadata of the transition to a target CX flow. Flow transition actions exit the caller playbook and enter the child flow. # Optional. Action performed on behalf of the agent by transitioning to a target CX flow.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
            &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
            &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
          },
          &quot;intentMatch&quot;: { # Stores metadata of the intent match action. # Optional. Output only. Intent Match in flows.
            &quot;matchedIntents&quot;: [ # The matched intent.
              { # Stores the matched intent, which is the result of the intent match action.
                &quot;displayName&quot;: &quot;A String&quot;, # The display name of the matched intent.
                &quot;generativeFallback&quot;: { # The generative fallback response of the matched intent.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;intentId&quot;: &quot;A String&quot;, # The ID of the matched intent.
                &quot;score&quot;: 3.14, # The score of the matched intent.
              },
            ],
          },
          &quot;llmCall&quot;: { # Stores metadata of the call of an LLM. # Optional. Output only. LLM call performed by the agent.
            &quot;model&quot;: &quot;A String&quot;, # The model of the LLM call.
            &quot;retrievedExamples&quot;: [ # A list of relevant examples used for the LLM prompt.
              { # Relevant example used for the LLM prompt.
                &quot;exampleDisplayName&quot;: &quot;A String&quot;, # The display name of the example.
                &quot;exampleId&quot;: &quot;A String&quot;, # The id of the example.
                &quot;matchedRetrievalLabel&quot;: &quot;A String&quot;, # Optional. The matched retrieval label of this LLM call.
                &quot;retrievalStrategy&quot;: &quot;A String&quot;, # Retrieval strategy of the example.
              },
            ],
            &quot;temperature&quot;: 3.14, # The temperature of the LLM call.
            &quot;tokenCount&quot;: { # Stores token counts of the LLM call. # The token counts of the LLM call.
              &quot;conversationContextTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the conversation history in the prompt.
              &quot;exampleTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the retrieved examples in the prompt.
              &quot;totalInputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the input to the LLM call.
              &quot;totalOutputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the output of the LLM call.
            },
          },
          &quot;playbookInvocation&quot;: { # Stores metadata of the invocation of a child playbook. Playbook invocation actions enter the child playbook. # Optional. Action performed on behalf of the agent by invoking a child playbook.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
            &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
            &quot;playbookInput&quot;: { # Input of the playbook. # Optional. Input of the child playbook invocation.
              &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
                &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
              },
              &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
            },
            &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. Output of the child playbook invocation.
              &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
                &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
              },
              &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
              &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
            },
            &quot;playbookState&quot;: &quot;A String&quot;, # Required. Playbook invocation&#x27;s output state.
          },
          &quot;playbookTransition&quot;: { # Stores metadata of the transition to another target playbook. Playbook transition actions exit the caller playbook and enter the target playbook. # Optional. Action performed on behalf of the agent by transitioning to a target playbook.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
            &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
          },
          &quot;startTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the start of the agent action.
          &quot;status&quot;: { # The status of the action. # Optional. Output only. The status of the action.
            &quot;exception&quot;: { # Exception thrown during the execution of an action. # Optional. The exception thrown during the execution of the action.
              &quot;errorMessage&quot;: &quot;A String&quot;, # Optional. The error message.
            },
          },
          &quot;stt&quot;: { # Stores metadata of the Speech-to-Text action. # Optional. Speech-to-text action performed by the agent.
          },
          &quot;subExecutionSteps&quot;: [ # Optional. The detailed tracing information for sub execution steps of the action.
            { # A span represents a sub execution step of an action.
              &quot;completeTime&quot;: &quot;A String&quot;, # Timestamp of the completion of the span.
              &quot;metrics&quot;: [ # The unordered collection of metrics in this span.
                { # A named metric is a metric with name, value and unit.
                  &quot;name&quot;: &quot;A String&quot;, # The name of the metric.
                  &quot;unit&quot;: &quot;A String&quot;, # The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard.
                  &quot;value&quot;: &quot;&quot;, # The value of the metric.
                },
              ],
              &quot;name&quot;: &quot;A String&quot;, # The name of the span.
              &quot;startTime&quot;: &quot;A String&quot;, # Timestamp of the start of the span.
              &quot;tags&quot;: [ # The metadata tags of the span such as span type.
                &quot;A String&quot;,
              ],
            },
          ],
          &quot;toolUse&quot;: { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
            &quot;action&quot;: &quot;A String&quot;, # Optional. Name of the action to be called during the tool use.
            &quot;dataStoreToolTrace&quot;: { # The tracing information for the data store tool. # Optional. Data store tool trace.
              &quot;dataStoreConnectionSignals&quot;: { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals.
                &quot;answer&quot;: &quot;A String&quot;, # Optional. The final compiled answer.
                &quot;answerGenerationModelCallSignals&quot;: { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call.
                  &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
                  &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
                  &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
                },
                &quot;answerParts&quot;: [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces).
                  { # Answer part with citation.
                    &quot;supportingIndices&quot;: [ # Citations for this answer part. Indices of `search_snippets`.
                      42,
                    ],
                    &quot;text&quot;: &quot;A String&quot;, # Substring of the answer.
                  },
                ],
                &quot;citedSnippets&quot;: [ # Optional. Snippets cited by the answer generation model from the most to least relevant.
                  { # Snippet cited by the answer generation model.
                    &quot;searchSnippet&quot;: { # Search snippet details. # Details of the snippet.
                      &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                      &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                      &quot;metadata&quot;: { # Metadata associated with the document.
                        &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                      },
                      &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
                    },
                    &quot;snippetIndex&quot;: 42, # Index of the snippet in `search_snippets` field.
                  },
                ],
                &quot;groundingSignals&quot;: { # Grounding signals. # Optional. Grounding signals.
                  &quot;decision&quot;: &quot;A String&quot;, # Represents the decision of the grounding check.
                  &quot;score&quot;: &quot;A String&quot;, # Grounding score bucket setting.
                },
                &quot;rewriterModelCallSignals&quot;: { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call.
                  &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
                  &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
                  &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
                },
                &quot;rewrittenQuery&quot;: &quot;A String&quot;, # Optional. Rewritten string query used for search.
                &quot;safetySignals&quot;: { # Safety check results. # Optional. Safety check result.
                  &quot;bannedPhraseMatch&quot;: &quot;A String&quot;, # Specifies banned phrase match subject.
                  &quot;decision&quot;: &quot;A String&quot;, # Safety decision.
                  &quot;matchedBannedPhrase&quot;: &quot;A String&quot;, # The matched banned phrase if there was a match.
                },
                &quot;searchSnippets&quot;: [ # Optional. Search snippets included in the answer generation prompt.
                  { # Search snippet details.
                    &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                    &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                    &quot;metadata&quot;: { # Metadata associated with the document.
                      &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                    },
                    &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
                  },
                ],
              },
            },
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool.
            &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;tool&quot;: &quot;A String&quot;, # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
            &quot;webhookToolTrace&quot;: { # The tracing information for the webhook tool. # Optional. Webhook tool trace.
              &quot;webhookTag&quot;: &quot;A String&quot;, # Optional. The tag of the webhook.
              &quot;webhookUri&quot;: &quot;A String&quot;, # Optional. The url of the webhook.
            },
          },
          &quot;tts&quot;: { # Stores metadata of the Text-to-Speech action. # Optional. Text-to-speech action performed by the agent.
          },
          &quot;userUtterance&quot;: { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
            &quot;audio&quot;: &quot;A String&quot;, # Optional. Audio input.
            &quot;audioTokens&quot;: [ # Optional. Tokens of the audio input.
              42,
            ],
            &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
          },
        },
      ],
      &quot;conversationState&quot;: &quot;A String&quot;, # Required. Example&#x27;s output state.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial example creation.
      &quot;description&quot;: &quot;A String&quot;, # Optional. The high level concise description of the example. The max number of characters is 200.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the example.
      &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The language code of the example. If not specified, the agent&#x27;s default language is used. Note: languages must be enabled in the agent before they can be used. Note: example&#x27;s language code is not currently used in dialogflow agents.
      &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
      &quot;playbookInput&quot;: { # Input of the playbook. # Optional. The input to the playbook in the example.
        &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
      },
      &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. The output of the playbook in the example.
        &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
        &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
      },
      &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current example takes when sent to the LLM.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the example was updated.
    },
  ],
  &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
  &quot;playbook&quot;: { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
    &quot;codeBlock&quot;: { # Represents a code block. # Optional. The playbook&#x27;s scoped code block, which may implement handlers and actions.
      &quot;code&quot;: &quot;A String&quot;, # Optional. Source code of the block in Python.
    },
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial playbook creation.
    &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the playbook, unique within an agent.
    &quot;goal&quot;: &quot;A String&quot;, # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it&#x27;s visible to other playbooks that may reference this playbook.
    &quot;handlers&quot;: [ # Optional. A list of registered handlers to execute based on the specified triggers.
      { # Handler can be used to define custom logic to be executed based on the user-specified triggers.
        &quot;eventHandler&quot;: { # A handler that is triggered by the specified event. # A handler triggered by event.
          &quot;condition&quot;: &quot;A String&quot;, # Optional. The condition that must be satisfied to trigger this handler.
          &quot;event&quot;: &quot;A String&quot;, # Required. The name of the event that triggers this handler.
          &quot;fulfillment&quot;: { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page&#x27;s entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to call when the event occurs.
            &quot;advancedSettings&quot;: { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent-&gt;Flow-&gt;Page-&gt;Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
              &quot;audioExportGcsDestination&quot;: { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
                &quot;uri&quot;: &quot;A String&quot;, # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
              },
              &quot;dtmfSettings&quot;: { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
                &quot;enabled&quot;: True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a &quot;3&quot; was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
                &quot;endpointingTimeoutDuration&quot;: &quot;A String&quot;, # Endpoint timeout setting for matching dtmf input to regex.
                &quot;finishDigit&quot;: &quot;A String&quot;, # The digit that terminates a DTMF digit sequence.
                &quot;interdigitTimeoutDuration&quot;: &quot;A String&quot;, # Interdigit timeout setting for matching dtmf input to regex.
                &quot;maxDigits&quot;: 42, # Max length of DTMF digits.
              },
              &quot;loggingSettings&quot;: { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
                &quot;enableConsentBasedRedaction&quot;: True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.
                &quot;enableInteractionLogging&quot;: True or False, # Enables DF Interaction logging.
                &quot;enableStackdriverLogging&quot;: True or False, # Enables Google Cloud Logging.
              },
              &quot;speechSettings&quot;: { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
                &quot;endpointerSensitivity&quot;: 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
                &quot;models&quot;: { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;noSpeechTimeout&quot;: &quot;A String&quot;, # Timeout before detecting no speech.
                &quot;useTimeoutBasedEndpointing&quot;: True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
              },
            },
            &quot;conditionalCases&quot;: [ # Conditional cases for this fulfillment.
              { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
                &quot;cases&quot;: [ # A list of cascading if-else conditions.
                  { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
                    &quot;caseContent&quot;: [ # A list of case content.
                      { # The list of messages or conditional cases to activate for this case.
                        &quot;additionalCases&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
                        &quot;message&quot;: { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message.
                          &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                          &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                            &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                          },
                          &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                          },
                          &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                          },
                          &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                            &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                          },
                          &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                            &quot;segments&quot;: [ # Segments this audio response is composed of.
                              { # Represents one segment of audio.
                                &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                                &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                                &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                              },
                            ],
                          },
                          &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                            &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                          },
                          &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                          },
                          &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                          },
                          &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                            &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                          },
                          &quot;text&quot;: { # The text response message. # Returns a text response.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                              &quot;A String&quot;,
                            ],
                          },
                          &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                            &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                            &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                            &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                          },
                        },
                      },
                    ],
                    &quot;condition&quot;: &quot;A String&quot;, # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
                  },
                ],
              },
            ],
            &quot;enableGenerativeFallback&quot;: True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
            &quot;generators&quot;: [ # A list of Generators to be called during this fulfillment.
              { # Generator settings used by the LLM to generate a text response.
                &quot;generator&quot;: &quot;A String&quot;, # Required. The generator to call. Format: `projects//locations//agents//generators/`.
                &quot;inputParameters&quot;: { # Map from placeholder parameter in the Generator to corresponding session parameters. By default, Dialogflow uses the session parameter with the same name to fill in the generator template. e.g. If there is a placeholder parameter `city` in the Generator, Dialogflow default to fill in the `$city` with `$session.params.city`. However, you may choose to fill `$city` with `$session.params.desination-city`. - Map key: parameter ID - Map value: session parameter name
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;outputParameter&quot;: &quot;A String&quot;, # Required. Output parameter which should contain the generator response.
              },
            ],
            &quot;messages&quot;: [ # The list of rich message responses to present to the user.
              { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.
                &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                  &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                },
                &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                },
                &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                },
                &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                  &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                },
                &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                  &quot;segments&quot;: [ # Segments this audio response is composed of.
                    { # Represents one segment of audio.
                      &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                      &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                      &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                    },
                  ],
                },
                &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                  &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                },
                &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                },
                &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                  &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                },
                &quot;text&quot;: { # The text response message. # Returns a text response.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                    &quot;A String&quot;,
                  ],
                },
                &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                  &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                  &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                  &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                },
              },
            ],
            &quot;returnPartialResponses&quot;: True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
            &quot;setParameterActions&quot;: [ # Set parameter values before executing the webhook.
              { # Setting a parameter value.
                &quot;parameter&quot;: &quot;A String&quot;, # Display name of the parameter.
                &quot;value&quot;: &quot;&quot;, # The new value of the parameter. A null value clears the parameter.
              },
            ],
            &quot;tag&quot;: &quot;A String&quot;, # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
            &quot;webhook&quot;: &quot;A String&quot;, # The webhook to call. Format: `projects//locations//agents//webhooks/`.
          },
        },
        &quot;lifecycleHandler&quot;: { # A handler that is triggered on the specific lifecycle_stage of the playbook execution. # A handler triggered during specific lifecycle of the playbook execution.
          &quot;condition&quot;: &quot;A String&quot;, # Optional. The condition that must be satisfied to trigger this handler.
          &quot;fulfillment&quot;: { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page&#x27;s entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to call when this handler is triggered.
            &quot;advancedSettings&quot;: { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent-&gt;Flow-&gt;Page-&gt;Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
              &quot;audioExportGcsDestination&quot;: { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
                &quot;uri&quot;: &quot;A String&quot;, # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
              },
              &quot;dtmfSettings&quot;: { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
                &quot;enabled&quot;: True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a &quot;3&quot; was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
                &quot;endpointingTimeoutDuration&quot;: &quot;A String&quot;, # Endpoint timeout setting for matching dtmf input to regex.
                &quot;finishDigit&quot;: &quot;A String&quot;, # The digit that terminates a DTMF digit sequence.
                &quot;interdigitTimeoutDuration&quot;: &quot;A String&quot;, # Interdigit timeout setting for matching dtmf input to regex.
                &quot;maxDigits&quot;: 42, # Max length of DTMF digits.
              },
              &quot;loggingSettings&quot;: { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
                &quot;enableConsentBasedRedaction&quot;: True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.
                &quot;enableInteractionLogging&quot;: True or False, # Enables DF Interaction logging.
                &quot;enableStackdriverLogging&quot;: True or False, # Enables Google Cloud Logging.
              },
              &quot;speechSettings&quot;: { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
                &quot;endpointerSensitivity&quot;: 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
                &quot;models&quot;: { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;noSpeechTimeout&quot;: &quot;A String&quot;, # Timeout before detecting no speech.
                &quot;useTimeoutBasedEndpointing&quot;: True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
              },
            },
            &quot;conditionalCases&quot;: [ # Conditional cases for this fulfillment.
              { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
                &quot;cases&quot;: [ # A list of cascading if-else conditions.
                  { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
                    &quot;caseContent&quot;: [ # A list of case content.
                      { # The list of messages or conditional cases to activate for this case.
                        &quot;additionalCases&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
                        &quot;message&quot;: { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message.
                          &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                          &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                            &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                          },
                          &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                          },
                          &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                          },
                          &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                            &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                          },
                          &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                            &quot;segments&quot;: [ # Segments this audio response is composed of.
                              { # Represents one segment of audio.
                                &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                                &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                                &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                              },
                            ],
                          },
                          &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                            &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                          },
                          &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                          },
                          &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                          },
                          &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                            &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                          },
                          &quot;text&quot;: { # The text response message. # Returns a text response.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                              &quot;A String&quot;,
                            ],
                          },
                          &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                            &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                            &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                            &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                          },
                        },
                      },
                    ],
                    &quot;condition&quot;: &quot;A String&quot;, # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
                  },
                ],
              },
            ],
            &quot;enableGenerativeFallback&quot;: True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
            &quot;generators&quot;: [ # A list of Generators to be called during this fulfillment.
              { # Generator settings used by the LLM to generate a text response.
                &quot;generator&quot;: &quot;A String&quot;, # Required. The generator to call. Format: `projects//locations//agents//generators/`.
                &quot;inputParameters&quot;: { # Map from placeholder parameter in the Generator to corresponding session parameters. By default, Dialogflow uses the session parameter with the same name to fill in the generator template. e.g. If there is a placeholder parameter `city` in the Generator, Dialogflow default to fill in the `$city` with `$session.params.city`. However, you may choose to fill `$city` with `$session.params.desination-city`. - Map key: parameter ID - Map value: session parameter name
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;outputParameter&quot;: &quot;A String&quot;, # Required. Output parameter which should contain the generator response.
              },
            ],
            &quot;messages&quot;: [ # The list of rich message responses to present to the user.
              { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.
                &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                  &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                },
                &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                },
                &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                },
                &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                  &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                },
                &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                  &quot;segments&quot;: [ # Segments this audio response is composed of.
                    { # Represents one segment of audio.
                      &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                      &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                      &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                    },
                  ],
                },
                &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                  &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                },
                &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                },
                &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                  &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                },
                &quot;text&quot;: { # The text response message. # Returns a text response.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                    &quot;A String&quot;,
                  ],
                },
                &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                  &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                  &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                  &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                },
              },
            ],
            &quot;returnPartialResponses&quot;: True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
            &quot;setParameterActions&quot;: [ # Set parameter values before executing the webhook.
              { # Setting a parameter value.
                &quot;parameter&quot;: &quot;A String&quot;, # Display name of the parameter.
                &quot;value&quot;: &quot;&quot;, # The new value of the parameter. A null value clears the parameter.
              },
            ],
            &quot;tag&quot;: &quot;A String&quot;, # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
            &quot;webhook&quot;: &quot;A String&quot;, # The webhook to call. Format: `projects//locations//agents//webhooks/`.
          },
          &quot;lifecycleStage&quot;: &quot;A String&quot;, # Required. The name of the lifecycle stage that triggers this handler. Supported values: * `playbook-start` * `pre-action-selection` * `pre-action-execution`
        },
      },
    ],
    &quot;inlineActions&quot;: [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook&#x27;s code block.
      &quot;A String&quot;,
    ],
    &quot;inputParameterDefinitions&quot;: [ # Optional. Defined structured input parameters for this playbook.
      { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
        &quot;description&quot;: &quot;A String&quot;, # Human-readable description of the parameter. Limited to 300 characters.
        &quot;name&quot;: &quot;A String&quot;, # Required. Name of parameter.
        &quot;type&quot;: &quot;A String&quot;, # Type of parameter.
        &quot;typeSchema&quot;: { # Encapsulates different type schema variations: either a reference to an a schema that&#x27;s already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
          &quot;inlineSchema&quot;: { # A type schema object that&#x27;s specified inline. # Set if this is an inline schema definition.
            &quot;items&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
            &quot;type&quot;: &quot;A String&quot;, # Data type of the schema.
          },
          &quot;schemaReference&quot;: { # A reference to the schema of an existing tool. # Set if this is a schema reference.
            &quot;schema&quot;: &quot;A String&quot;, # The name of the schema.
            &quot;tool&quot;: &quot;A String&quot;, # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
          },
        },
      },
    ],
    &quot;instruction&quot;: { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
      &quot;guidelines&quot;: &quot;A String&quot;, # General guidelines for the playbook. These are unstructured instructions that are not directly part of the goal, e.g. &quot;Always be polite&quot;. It&#x27;s valid for this text to be long and used instead of steps altogether.
      &quot;steps&quot;: [ # Ordered list of step by step execution instructions to accomplish target goal.
        { # Message of single step execution.
          &quot;steps&quot;: [ # Sub-processing needed to execute the current step.
            # Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
          ],
          &quot;text&quot;: &quot;A String&quot;, # Step instruction in text format.
        },
      ],
    },
    &quot;llmModelSettings&quot;: { # Settings for LLM models. # Optional. Llm model settings for the playbook.
      &quot;model&quot;: &quot;A String&quot;, # The selected LLM model.
      &quot;parameters&quot;: { # Generative model parameters to control the model behavior. # Generative model parameters.
        &quot;inputTokenLimit&quot;: &quot;A String&quot;, # The input token limit. This setting is currently only supported by playbooks.
        &quot;outputTokenLimit&quot;: &quot;A String&quot;, # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set.
        &quot;temperature&quot;: 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0]
      },
      &quot;promptText&quot;: &quot;A String&quot;, # The custom prompt to use.
    },
    &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
    &quot;outputParameterDefinitions&quot;: [ # Optional. Defined structured output parameters for this playbook.
      { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
        &quot;description&quot;: &quot;A String&quot;, # Human-readable description of the parameter. Limited to 300 characters.
        &quot;name&quot;: &quot;A String&quot;, # Required. Name of parameter.
        &quot;type&quot;: &quot;A String&quot;, # Type of parameter.
        &quot;typeSchema&quot;: { # Encapsulates different type schema variations: either a reference to an a schema that&#x27;s already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
          &quot;inlineSchema&quot;: { # A type schema object that&#x27;s specified inline. # Set if this is an inline schema definition.
            &quot;items&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
            &quot;type&quot;: &quot;A String&quot;, # Data type of the schema.
          },
          &quot;schemaReference&quot;: { # A reference to the schema of an existing tool. # Set if this is a schema reference.
            &quot;schema&quot;: &quot;A String&quot;, # The name of the schema.
            &quot;tool&quot;: &quot;A String&quot;, # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
          },
        },
      },
    ],
    &quot;playbookType&quot;: &quot;A String&quot;, # Optional. Type of the playbook.
    &quot;referencedFlows&quot;: [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
      &quot;A String&quot;,
    ],
    &quot;referencedPlaybooks&quot;: [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
      &quot;A String&quot;,
    ],
    &quot;referencedTools&quot;: [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
      &quot;A String&quot;,
    ],
    &quot;speechSettings&quot;: { # Define behaviors of speech to text detection. # Optional. Playbook level Settings for speech to text detection.
      &quot;endpointerSensitivity&quot;: 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
      &quot;models&quot;: { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;noSpeechTimeout&quot;: &quot;A String&quot;, # Timeout before detecting no speech.
      &quot;useTimeoutBasedEndpointing&quot;: True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
    },
    &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the playbook version was updated.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the playbook version was created or modified.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Playbook version is a snapshot of the playbook at certain timestamp.
  &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the playbook version.
  &quot;examples&quot;: [ # Output only. Snapshot of the examples belonging to the playbook when the playbook version is created.
    { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
      &quot;actions&quot;: [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
        { # Action performed by end user or Dialogflow agent in the conversation.
          &quot;agentUtterance&quot;: { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
            &quot;requireGeneration&quot;: True or False, # Optional. True if the agent utterance needs to be generated by the LLM. Only used in webhook response to differentiate from empty text. Revisit whether we need this field or mark `text` as optional when we expose webhook interface to customer.
            &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
          },
          &quot;completeTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the completion of the agent action.
          &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the action.
          &quot;event&quot;: { # Event represents the event sent by the customer. # Optional. The agent received an event from the customer or a system event is emitted.
            &quot;event&quot;: &quot;A String&quot;, # Required. Name of the event.
            &quot;text&quot;: &quot;A String&quot;, # Optional. Unstructured text payload of the event.
          },
          &quot;flowInvocation&quot;: { # Stores metadata of the invocation of a child CX flow. Flow invocation actions enter the child flow. # Optional. Action performed on behalf of the agent by invoking a CX flow.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
            &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
            &quot;flowState&quot;: &quot;A String&quot;, # Required. Flow invocation&#x27;s output state.
            &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the flow.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the flow invocation.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
          },
          &quot;flowStateUpdate&quot;: { # Stores metadata of the state update action, such as a state machine execution in flows. # Optional. Output only. The state machine update in flows.
            &quot;destination&quot;: &quot;A String&quot;, # The destination of the transition. Format: `projects//locations//agents//flows//pages/` or `projects//locations//agents//playbooks/`.
            &quot;eventType&quot;: &quot;A String&quot;, # The type of the event that triggered the state update.
            &quot;functionCall&quot;: { # Stores the metadata of a function call to execute. # The function call to execute.
              &quot;name&quot;: &quot;A String&quot;, # The name of the function call.
            },
            &quot;pageState&quot;: { # Stores the state of a page and its flow. # The updated page and flow state.
              &quot;displayName&quot;: &quot;A String&quot;, # The display name of the page.
              &quot;page&quot;: &quot;A String&quot;, # The ID of the page. Format: `projects//locations//agents//flows//pages/`.
              &quot;status&quot;: &quot;A String&quot;, # The status of the page.
            },
            &quot;updatedParameters&quot;: { # The updated parameters.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
          },
          &quot;flowTransition&quot;: { # Stores metadata of the transition to a target CX flow. Flow transition actions exit the caller playbook and enter the child flow. # Optional. Action performed on behalf of the agent by transitioning to a target CX flow.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
            &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
            &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
          },
          &quot;intentMatch&quot;: { # Stores metadata of the intent match action. # Optional. Output only. Intent Match in flows.
            &quot;matchedIntents&quot;: [ # The matched intent.
              { # Stores the matched intent, which is the result of the intent match action.
                &quot;displayName&quot;: &quot;A String&quot;, # The display name of the matched intent.
                &quot;generativeFallback&quot;: { # The generative fallback response of the matched intent.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;intentId&quot;: &quot;A String&quot;, # The ID of the matched intent.
                &quot;score&quot;: 3.14, # The score of the matched intent.
              },
            ],
          },
          &quot;llmCall&quot;: { # Stores metadata of the call of an LLM. # Optional. Output only. LLM call performed by the agent.
            &quot;model&quot;: &quot;A String&quot;, # The model of the LLM call.
            &quot;retrievedExamples&quot;: [ # A list of relevant examples used for the LLM prompt.
              { # Relevant example used for the LLM prompt.
                &quot;exampleDisplayName&quot;: &quot;A String&quot;, # The display name of the example.
                &quot;exampleId&quot;: &quot;A String&quot;, # The id of the example.
                &quot;matchedRetrievalLabel&quot;: &quot;A String&quot;, # Optional. The matched retrieval label of this LLM call.
                &quot;retrievalStrategy&quot;: &quot;A String&quot;, # Retrieval strategy of the example.
              },
            ],
            &quot;temperature&quot;: 3.14, # The temperature of the LLM call.
            &quot;tokenCount&quot;: { # Stores token counts of the LLM call. # The token counts of the LLM call.
              &quot;conversationContextTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the conversation history in the prompt.
              &quot;exampleTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the retrieved examples in the prompt.
              &quot;totalInputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the input to the LLM call.
              &quot;totalOutputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the output of the LLM call.
            },
          },
          &quot;playbookInvocation&quot;: { # Stores metadata of the invocation of a child playbook. Playbook invocation actions enter the child playbook. # Optional. Action performed on behalf of the agent by invoking a child playbook.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
            &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
            &quot;playbookInput&quot;: { # Input of the playbook. # Optional. Input of the child playbook invocation.
              &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
                &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
              },
              &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
            },
            &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. Output of the child playbook invocation.
              &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
                &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
              },
              &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
              &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
            },
            &quot;playbookState&quot;: &quot;A String&quot;, # Required. Playbook invocation&#x27;s output state.
          },
          &quot;playbookTransition&quot;: { # Stores metadata of the transition to another target playbook. Playbook transition actions exit the caller playbook and enter the target playbook. # Optional. Action performed on behalf of the agent by transitioning to a target playbook.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
            &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
          },
          &quot;startTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the start of the agent action.
          &quot;status&quot;: { # The status of the action. # Optional. Output only. The status of the action.
            &quot;exception&quot;: { # Exception thrown during the execution of an action. # Optional. The exception thrown during the execution of the action.
              &quot;errorMessage&quot;: &quot;A String&quot;, # Optional. The error message.
            },
          },
          &quot;stt&quot;: { # Stores metadata of the Speech-to-Text action. # Optional. Speech-to-text action performed by the agent.
          },
          &quot;subExecutionSteps&quot;: [ # Optional. The detailed tracing information for sub execution steps of the action.
            { # A span represents a sub execution step of an action.
              &quot;completeTime&quot;: &quot;A String&quot;, # Timestamp of the completion of the span.
              &quot;metrics&quot;: [ # The unordered collection of metrics in this span.
                { # A named metric is a metric with name, value and unit.
                  &quot;name&quot;: &quot;A String&quot;, # The name of the metric.
                  &quot;unit&quot;: &quot;A String&quot;, # The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard.
                  &quot;value&quot;: &quot;&quot;, # The value of the metric.
                },
              ],
              &quot;name&quot;: &quot;A String&quot;, # The name of the span.
              &quot;startTime&quot;: &quot;A String&quot;, # Timestamp of the start of the span.
              &quot;tags&quot;: [ # The metadata tags of the span such as span type.
                &quot;A String&quot;,
              ],
            },
          ],
          &quot;toolUse&quot;: { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
            &quot;action&quot;: &quot;A String&quot;, # Optional. Name of the action to be called during the tool use.
            &quot;dataStoreToolTrace&quot;: { # The tracing information for the data store tool. # Optional. Data store tool trace.
              &quot;dataStoreConnectionSignals&quot;: { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals.
                &quot;answer&quot;: &quot;A String&quot;, # Optional. The final compiled answer.
                &quot;answerGenerationModelCallSignals&quot;: { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call.
                  &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
                  &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
                  &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
                },
                &quot;answerParts&quot;: [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces).
                  { # Answer part with citation.
                    &quot;supportingIndices&quot;: [ # Citations for this answer part. Indices of `search_snippets`.
                      42,
                    ],
                    &quot;text&quot;: &quot;A String&quot;, # Substring of the answer.
                  },
                ],
                &quot;citedSnippets&quot;: [ # Optional. Snippets cited by the answer generation model from the most to least relevant.
                  { # Snippet cited by the answer generation model.
                    &quot;searchSnippet&quot;: { # Search snippet details. # Details of the snippet.
                      &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                      &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                      &quot;metadata&quot;: { # Metadata associated with the document.
                        &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                      },
                      &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
                    },
                    &quot;snippetIndex&quot;: 42, # Index of the snippet in `search_snippets` field.
                  },
                ],
                &quot;groundingSignals&quot;: { # Grounding signals. # Optional. Grounding signals.
                  &quot;decision&quot;: &quot;A String&quot;, # Represents the decision of the grounding check.
                  &quot;score&quot;: &quot;A String&quot;, # Grounding score bucket setting.
                },
                &quot;rewriterModelCallSignals&quot;: { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call.
                  &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
                  &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
                  &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
                },
                &quot;rewrittenQuery&quot;: &quot;A String&quot;, # Optional. Rewritten string query used for search.
                &quot;safetySignals&quot;: { # Safety check results. # Optional. Safety check result.
                  &quot;bannedPhraseMatch&quot;: &quot;A String&quot;, # Specifies banned phrase match subject.
                  &quot;decision&quot;: &quot;A String&quot;, # Safety decision.
                  &quot;matchedBannedPhrase&quot;: &quot;A String&quot;, # The matched banned phrase if there was a match.
                },
                &quot;searchSnippets&quot;: [ # Optional. Search snippets included in the answer generation prompt.
                  { # Search snippet details.
                    &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                    &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                    &quot;metadata&quot;: { # Metadata associated with the document.
                      &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                    },
                    &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
                  },
                ],
              },
            },
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool.
            &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;tool&quot;: &quot;A String&quot;, # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
            &quot;webhookToolTrace&quot;: { # The tracing information for the webhook tool. # Optional. Webhook tool trace.
              &quot;webhookTag&quot;: &quot;A String&quot;, # Optional. The tag of the webhook.
              &quot;webhookUri&quot;: &quot;A String&quot;, # Optional. The url of the webhook.
            },
          },
          &quot;tts&quot;: { # Stores metadata of the Text-to-Speech action. # Optional. Text-to-speech action performed by the agent.
          },
          &quot;userUtterance&quot;: { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
            &quot;audio&quot;: &quot;A String&quot;, # Optional. Audio input.
            &quot;audioTokens&quot;: [ # Optional. Tokens of the audio input.
              42,
            ],
            &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
          },
        },
      ],
      &quot;conversationState&quot;: &quot;A String&quot;, # Required. Example&#x27;s output state.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial example creation.
      &quot;description&quot;: &quot;A String&quot;, # Optional. The high level concise description of the example. The max number of characters is 200.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the example.
      &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The language code of the example. If not specified, the agent&#x27;s default language is used. Note: languages must be enabled in the agent before they can be used. Note: example&#x27;s language code is not currently used in dialogflow agents.
      &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
      &quot;playbookInput&quot;: { # Input of the playbook. # Optional. The input to the playbook in the example.
        &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
      },
      &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. The output of the playbook in the example.
        &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
        &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
      },
      &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current example takes when sent to the LLM.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the example was updated.
    },
  ],
  &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
  &quot;playbook&quot;: { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
    &quot;codeBlock&quot;: { # Represents a code block. # Optional. The playbook&#x27;s scoped code block, which may implement handlers and actions.
      &quot;code&quot;: &quot;A String&quot;, # Optional. Source code of the block in Python.
    },
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial playbook creation.
    &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the playbook, unique within an agent.
    &quot;goal&quot;: &quot;A String&quot;, # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it&#x27;s visible to other playbooks that may reference this playbook.
    &quot;handlers&quot;: [ # Optional. A list of registered handlers to execute based on the specified triggers.
      { # Handler can be used to define custom logic to be executed based on the user-specified triggers.
        &quot;eventHandler&quot;: { # A handler that is triggered by the specified event. # A handler triggered by event.
          &quot;condition&quot;: &quot;A String&quot;, # Optional. The condition that must be satisfied to trigger this handler.
          &quot;event&quot;: &quot;A String&quot;, # Required. The name of the event that triggers this handler.
          &quot;fulfillment&quot;: { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page&#x27;s entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to call when the event occurs.
            &quot;advancedSettings&quot;: { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent-&gt;Flow-&gt;Page-&gt;Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
              &quot;audioExportGcsDestination&quot;: { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
                &quot;uri&quot;: &quot;A String&quot;, # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
              },
              &quot;dtmfSettings&quot;: { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
                &quot;enabled&quot;: True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a &quot;3&quot; was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
                &quot;endpointingTimeoutDuration&quot;: &quot;A String&quot;, # Endpoint timeout setting for matching dtmf input to regex.
                &quot;finishDigit&quot;: &quot;A String&quot;, # The digit that terminates a DTMF digit sequence.
                &quot;interdigitTimeoutDuration&quot;: &quot;A String&quot;, # Interdigit timeout setting for matching dtmf input to regex.
                &quot;maxDigits&quot;: 42, # Max length of DTMF digits.
              },
              &quot;loggingSettings&quot;: { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
                &quot;enableConsentBasedRedaction&quot;: True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.
                &quot;enableInteractionLogging&quot;: True or False, # Enables DF Interaction logging.
                &quot;enableStackdriverLogging&quot;: True or False, # Enables Google Cloud Logging.
              },
              &quot;speechSettings&quot;: { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
                &quot;endpointerSensitivity&quot;: 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
                &quot;models&quot;: { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;noSpeechTimeout&quot;: &quot;A String&quot;, # Timeout before detecting no speech.
                &quot;useTimeoutBasedEndpointing&quot;: True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
              },
            },
            &quot;conditionalCases&quot;: [ # Conditional cases for this fulfillment.
              { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
                &quot;cases&quot;: [ # A list of cascading if-else conditions.
                  { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
                    &quot;caseContent&quot;: [ # A list of case content.
                      { # The list of messages or conditional cases to activate for this case.
                        &quot;additionalCases&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
                        &quot;message&quot;: { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message.
                          &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                          &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                            &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                          },
                          &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                          },
                          &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                          },
                          &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                            &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                          },
                          &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                            &quot;segments&quot;: [ # Segments this audio response is composed of.
                              { # Represents one segment of audio.
                                &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                                &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                                &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                              },
                            ],
                          },
                          &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                            &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                          },
                          &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                          },
                          &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                          },
                          &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                            &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                          },
                          &quot;text&quot;: { # The text response message. # Returns a text response.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                              &quot;A String&quot;,
                            ],
                          },
                          &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                            &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                            &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                            &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                          },
                        },
                      },
                    ],
                    &quot;condition&quot;: &quot;A String&quot;, # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
                  },
                ],
              },
            ],
            &quot;enableGenerativeFallback&quot;: True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
            &quot;generators&quot;: [ # A list of Generators to be called during this fulfillment.
              { # Generator settings used by the LLM to generate a text response.
                &quot;generator&quot;: &quot;A String&quot;, # Required. The generator to call. Format: `projects//locations//agents//generators/`.
                &quot;inputParameters&quot;: { # Map from placeholder parameter in the Generator to corresponding session parameters. By default, Dialogflow uses the session parameter with the same name to fill in the generator template. e.g. If there is a placeholder parameter `city` in the Generator, Dialogflow default to fill in the `$city` with `$session.params.city`. However, you may choose to fill `$city` with `$session.params.desination-city`. - Map key: parameter ID - Map value: session parameter name
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;outputParameter&quot;: &quot;A String&quot;, # Required. Output parameter which should contain the generator response.
              },
            ],
            &quot;messages&quot;: [ # The list of rich message responses to present to the user.
              { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.
                &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                  &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                },
                &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                },
                &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                },
                &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                  &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                },
                &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                  &quot;segments&quot;: [ # Segments this audio response is composed of.
                    { # Represents one segment of audio.
                      &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                      &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                      &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                    },
                  ],
                },
                &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                  &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                },
                &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                },
                &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                  &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                },
                &quot;text&quot;: { # The text response message. # Returns a text response.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                    &quot;A String&quot;,
                  ],
                },
                &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                  &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                  &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                  &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                },
              },
            ],
            &quot;returnPartialResponses&quot;: True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
            &quot;setParameterActions&quot;: [ # Set parameter values before executing the webhook.
              { # Setting a parameter value.
                &quot;parameter&quot;: &quot;A String&quot;, # Display name of the parameter.
                &quot;value&quot;: &quot;&quot;, # The new value of the parameter. A null value clears the parameter.
              },
            ],
            &quot;tag&quot;: &quot;A String&quot;, # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
            &quot;webhook&quot;: &quot;A String&quot;, # The webhook to call. Format: `projects//locations//agents//webhooks/`.
          },
        },
        &quot;lifecycleHandler&quot;: { # A handler that is triggered on the specific lifecycle_stage of the playbook execution. # A handler triggered during specific lifecycle of the playbook execution.
          &quot;condition&quot;: &quot;A String&quot;, # Optional. The condition that must be satisfied to trigger this handler.
          &quot;fulfillment&quot;: { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page&#x27;s entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to call when this handler is triggered.
            &quot;advancedSettings&quot;: { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent-&gt;Flow-&gt;Page-&gt;Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
              &quot;audioExportGcsDestination&quot;: { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
                &quot;uri&quot;: &quot;A String&quot;, # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
              },
              &quot;dtmfSettings&quot;: { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
                &quot;enabled&quot;: True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a &quot;3&quot; was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
                &quot;endpointingTimeoutDuration&quot;: &quot;A String&quot;, # Endpoint timeout setting for matching dtmf input to regex.
                &quot;finishDigit&quot;: &quot;A String&quot;, # The digit that terminates a DTMF digit sequence.
                &quot;interdigitTimeoutDuration&quot;: &quot;A String&quot;, # Interdigit timeout setting for matching dtmf input to regex.
                &quot;maxDigits&quot;: 42, # Max length of DTMF digits.
              },
              &quot;loggingSettings&quot;: { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
                &quot;enableConsentBasedRedaction&quot;: True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.
                &quot;enableInteractionLogging&quot;: True or False, # Enables DF Interaction logging.
                &quot;enableStackdriverLogging&quot;: True or False, # Enables Google Cloud Logging.
              },
              &quot;speechSettings&quot;: { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
                &quot;endpointerSensitivity&quot;: 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
                &quot;models&quot;: { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;noSpeechTimeout&quot;: &quot;A String&quot;, # Timeout before detecting no speech.
                &quot;useTimeoutBasedEndpointing&quot;: True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
              },
            },
            &quot;conditionalCases&quot;: [ # Conditional cases for this fulfillment.
              { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
                &quot;cases&quot;: [ # A list of cascading if-else conditions.
                  { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
                    &quot;caseContent&quot;: [ # A list of case content.
                      { # The list of messages or conditional cases to activate for this case.
                        &quot;additionalCases&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
                        &quot;message&quot;: { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message.
                          &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                          &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                            &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                          },
                          &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                          },
                          &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                          },
                          &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                            &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                          },
                          &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                            &quot;segments&quot;: [ # Segments this audio response is composed of.
                              { # Represents one segment of audio.
                                &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                                &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                                &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                              },
                            ],
                          },
                          &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                            &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                          },
                          &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                          },
                          &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                          },
                          &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                            &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                          },
                          &quot;text&quot;: { # The text response message. # Returns a text response.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                              &quot;A String&quot;,
                            ],
                          },
                          &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                            &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                            &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                            &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                          },
                        },
                      },
                    ],
                    &quot;condition&quot;: &quot;A String&quot;, # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
                  },
                ],
              },
            ],
            &quot;enableGenerativeFallback&quot;: True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
            &quot;generators&quot;: [ # A list of Generators to be called during this fulfillment.
              { # Generator settings used by the LLM to generate a text response.
                &quot;generator&quot;: &quot;A String&quot;, # Required. The generator to call. Format: `projects//locations//agents//generators/`.
                &quot;inputParameters&quot;: { # Map from placeholder parameter in the Generator to corresponding session parameters. By default, Dialogflow uses the session parameter with the same name to fill in the generator template. e.g. If there is a placeholder parameter `city` in the Generator, Dialogflow default to fill in the `$city` with `$session.params.city`. However, you may choose to fill `$city` with `$session.params.desination-city`. - Map key: parameter ID - Map value: session parameter name
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;outputParameter&quot;: &quot;A String&quot;, # Required. Output parameter which should contain the generator response.
              },
            ],
            &quot;messages&quot;: [ # The list of rich message responses to present to the user.
              { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.
                &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                  &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                },
                &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                },
                &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                },
                &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                  &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                },
                &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                  &quot;segments&quot;: [ # Segments this audio response is composed of.
                    { # Represents one segment of audio.
                      &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                      &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                      &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                    },
                  ],
                },
                &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                  &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                },
                &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                },
                &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                  &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                },
                &quot;text&quot;: { # The text response message. # Returns a text response.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                    &quot;A String&quot;,
                  ],
                },
                &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                  &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                  &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                  &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                },
              },
            ],
            &quot;returnPartialResponses&quot;: True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
            &quot;setParameterActions&quot;: [ # Set parameter values before executing the webhook.
              { # Setting a parameter value.
                &quot;parameter&quot;: &quot;A String&quot;, # Display name of the parameter.
                &quot;value&quot;: &quot;&quot;, # The new value of the parameter. A null value clears the parameter.
              },
            ],
            &quot;tag&quot;: &quot;A String&quot;, # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
            &quot;webhook&quot;: &quot;A String&quot;, # The webhook to call. Format: `projects//locations//agents//webhooks/`.
          },
          &quot;lifecycleStage&quot;: &quot;A String&quot;, # Required. The name of the lifecycle stage that triggers this handler. Supported values: * `playbook-start` * `pre-action-selection` * `pre-action-execution`
        },
      },
    ],
    &quot;inlineActions&quot;: [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook&#x27;s code block.
      &quot;A String&quot;,
    ],
    &quot;inputParameterDefinitions&quot;: [ # Optional. Defined structured input parameters for this playbook.
      { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
        &quot;description&quot;: &quot;A String&quot;, # Human-readable description of the parameter. Limited to 300 characters.
        &quot;name&quot;: &quot;A String&quot;, # Required. Name of parameter.
        &quot;type&quot;: &quot;A String&quot;, # Type of parameter.
        &quot;typeSchema&quot;: { # Encapsulates different type schema variations: either a reference to an a schema that&#x27;s already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
          &quot;inlineSchema&quot;: { # A type schema object that&#x27;s specified inline. # Set if this is an inline schema definition.
            &quot;items&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
            &quot;type&quot;: &quot;A String&quot;, # Data type of the schema.
          },
          &quot;schemaReference&quot;: { # A reference to the schema of an existing tool. # Set if this is a schema reference.
            &quot;schema&quot;: &quot;A String&quot;, # The name of the schema.
            &quot;tool&quot;: &quot;A String&quot;, # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
          },
        },
      },
    ],
    &quot;instruction&quot;: { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
      &quot;guidelines&quot;: &quot;A String&quot;, # General guidelines for the playbook. These are unstructured instructions that are not directly part of the goal, e.g. &quot;Always be polite&quot;. It&#x27;s valid for this text to be long and used instead of steps altogether.
      &quot;steps&quot;: [ # Ordered list of step by step execution instructions to accomplish target goal.
        { # Message of single step execution.
          &quot;steps&quot;: [ # Sub-processing needed to execute the current step.
            # Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
          ],
          &quot;text&quot;: &quot;A String&quot;, # Step instruction in text format.
        },
      ],
    },
    &quot;llmModelSettings&quot;: { # Settings for LLM models. # Optional. Llm model settings for the playbook.
      &quot;model&quot;: &quot;A String&quot;, # The selected LLM model.
      &quot;parameters&quot;: { # Generative model parameters to control the model behavior. # Generative model parameters.
        &quot;inputTokenLimit&quot;: &quot;A String&quot;, # The input token limit. This setting is currently only supported by playbooks.
        &quot;outputTokenLimit&quot;: &quot;A String&quot;, # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set.
        &quot;temperature&quot;: 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0]
      },
      &quot;promptText&quot;: &quot;A String&quot;, # The custom prompt to use.
    },
    &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
    &quot;outputParameterDefinitions&quot;: [ # Optional. Defined structured output parameters for this playbook.
      { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
        &quot;description&quot;: &quot;A String&quot;, # Human-readable description of the parameter. Limited to 300 characters.
        &quot;name&quot;: &quot;A String&quot;, # Required. Name of parameter.
        &quot;type&quot;: &quot;A String&quot;, # Type of parameter.
        &quot;typeSchema&quot;: { # Encapsulates different type schema variations: either a reference to an a schema that&#x27;s already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
          &quot;inlineSchema&quot;: { # A type schema object that&#x27;s specified inline. # Set if this is an inline schema definition.
            &quot;items&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
            &quot;type&quot;: &quot;A String&quot;, # Data type of the schema.
          },
          &quot;schemaReference&quot;: { # A reference to the schema of an existing tool. # Set if this is a schema reference.
            &quot;schema&quot;: &quot;A String&quot;, # The name of the schema.
            &quot;tool&quot;: &quot;A String&quot;, # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
          },
        },
      },
    ],
    &quot;playbookType&quot;: &quot;A String&quot;, # Optional. Type of the playbook.
    &quot;referencedFlows&quot;: [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
      &quot;A String&quot;,
    ],
    &quot;referencedPlaybooks&quot;: [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
      &quot;A String&quot;,
    ],
    &quot;referencedTools&quot;: [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
      &quot;A String&quot;,
    ],
    &quot;speechSettings&quot;: { # Define behaviors of speech to text detection. # Optional. Playbook level Settings for speech to text detection.
      &quot;endpointerSensitivity&quot;: 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
      &quot;models&quot;: { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;noSpeechTimeout&quot;: &quot;A String&quot;, # Timeout before detecting no speech.
      &quot;useTimeoutBasedEndpointing&quot;: True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
    },
    &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the playbook version was updated.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the playbook version was created or modified.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes the specified version of the Playbook.

Args:
  name: string, Required. The name of the playbook version to delete. Format: `projects//locations//agents//playbooks//versions/`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Retrieves the specified version of the Playbook.

Args:
  name: string, Required. The name of the playbook version. Format: `projects//locations//agents//playbooks//versions/`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Playbook version is a snapshot of the playbook at certain timestamp.
  &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the playbook version.
  &quot;examples&quot;: [ # Output only. Snapshot of the examples belonging to the playbook when the playbook version is created.
    { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
      &quot;actions&quot;: [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
        { # Action performed by end user or Dialogflow agent in the conversation.
          &quot;agentUtterance&quot;: { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
            &quot;requireGeneration&quot;: True or False, # Optional. True if the agent utterance needs to be generated by the LLM. Only used in webhook response to differentiate from empty text. Revisit whether we need this field or mark `text` as optional when we expose webhook interface to customer.
            &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
          },
          &quot;completeTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the completion of the agent action.
          &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the action.
          &quot;event&quot;: { # Event represents the event sent by the customer. # Optional. The agent received an event from the customer or a system event is emitted.
            &quot;event&quot;: &quot;A String&quot;, # Required. Name of the event.
            &quot;text&quot;: &quot;A String&quot;, # Optional. Unstructured text payload of the event.
          },
          &quot;flowInvocation&quot;: { # Stores metadata of the invocation of a child CX flow. Flow invocation actions enter the child flow. # Optional. Action performed on behalf of the agent by invoking a CX flow.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
            &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
            &quot;flowState&quot;: &quot;A String&quot;, # Required. Flow invocation&#x27;s output state.
            &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the flow.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the flow invocation.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
          },
          &quot;flowStateUpdate&quot;: { # Stores metadata of the state update action, such as a state machine execution in flows. # Optional. Output only. The state machine update in flows.
            &quot;destination&quot;: &quot;A String&quot;, # The destination of the transition. Format: `projects//locations//agents//flows//pages/` or `projects//locations//agents//playbooks/`.
            &quot;eventType&quot;: &quot;A String&quot;, # The type of the event that triggered the state update.
            &quot;functionCall&quot;: { # Stores the metadata of a function call to execute. # The function call to execute.
              &quot;name&quot;: &quot;A String&quot;, # The name of the function call.
            },
            &quot;pageState&quot;: { # Stores the state of a page and its flow. # The updated page and flow state.
              &quot;displayName&quot;: &quot;A String&quot;, # The display name of the page.
              &quot;page&quot;: &quot;A String&quot;, # The ID of the page. Format: `projects//locations//agents//flows//pages/`.
              &quot;status&quot;: &quot;A String&quot;, # The status of the page.
            },
            &quot;updatedParameters&quot;: { # The updated parameters.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
          },
          &quot;flowTransition&quot;: { # Stores metadata of the transition to a target CX flow. Flow transition actions exit the caller playbook and enter the child flow. # Optional. Action performed on behalf of the agent by transitioning to a target CX flow.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
            &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
            &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
          },
          &quot;intentMatch&quot;: { # Stores metadata of the intent match action. # Optional. Output only. Intent Match in flows.
            &quot;matchedIntents&quot;: [ # The matched intent.
              { # Stores the matched intent, which is the result of the intent match action.
                &quot;displayName&quot;: &quot;A String&quot;, # The display name of the matched intent.
                &quot;generativeFallback&quot;: { # The generative fallback response of the matched intent.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;intentId&quot;: &quot;A String&quot;, # The ID of the matched intent.
                &quot;score&quot;: 3.14, # The score of the matched intent.
              },
            ],
          },
          &quot;llmCall&quot;: { # Stores metadata of the call of an LLM. # Optional. Output only. LLM call performed by the agent.
            &quot;model&quot;: &quot;A String&quot;, # The model of the LLM call.
            &quot;retrievedExamples&quot;: [ # A list of relevant examples used for the LLM prompt.
              { # Relevant example used for the LLM prompt.
                &quot;exampleDisplayName&quot;: &quot;A String&quot;, # The display name of the example.
                &quot;exampleId&quot;: &quot;A String&quot;, # The id of the example.
                &quot;matchedRetrievalLabel&quot;: &quot;A String&quot;, # Optional. The matched retrieval label of this LLM call.
                &quot;retrievalStrategy&quot;: &quot;A String&quot;, # Retrieval strategy of the example.
              },
            ],
            &quot;temperature&quot;: 3.14, # The temperature of the LLM call.
            &quot;tokenCount&quot;: { # Stores token counts of the LLM call. # The token counts of the LLM call.
              &quot;conversationContextTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the conversation history in the prompt.
              &quot;exampleTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the retrieved examples in the prompt.
              &quot;totalInputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the input to the LLM call.
              &quot;totalOutputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the output of the LLM call.
            },
          },
          &quot;playbookInvocation&quot;: { # Stores metadata of the invocation of a child playbook. Playbook invocation actions enter the child playbook. # Optional. Action performed on behalf of the agent by invoking a child playbook.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
            &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
            &quot;playbookInput&quot;: { # Input of the playbook. # Optional. Input of the child playbook invocation.
              &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
                &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
              },
              &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
            },
            &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. Output of the child playbook invocation.
              &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
                &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
              },
              &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
              &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
            },
            &quot;playbookState&quot;: &quot;A String&quot;, # Required. Playbook invocation&#x27;s output state.
          },
          &quot;playbookTransition&quot;: { # Stores metadata of the transition to another target playbook. Playbook transition actions exit the caller playbook and enter the target playbook. # Optional. Action performed on behalf of the agent by transitioning to a target playbook.
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
            &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
          },
          &quot;startTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the start of the agent action.
          &quot;status&quot;: { # The status of the action. # Optional. Output only. The status of the action.
            &quot;exception&quot;: { # Exception thrown during the execution of an action. # Optional. The exception thrown during the execution of the action.
              &quot;errorMessage&quot;: &quot;A String&quot;, # Optional. The error message.
            },
          },
          &quot;stt&quot;: { # Stores metadata of the Speech-to-Text action. # Optional. Speech-to-text action performed by the agent.
          },
          &quot;subExecutionSteps&quot;: [ # Optional. The detailed tracing information for sub execution steps of the action.
            { # A span represents a sub execution step of an action.
              &quot;completeTime&quot;: &quot;A String&quot;, # Timestamp of the completion of the span.
              &quot;metrics&quot;: [ # The unordered collection of metrics in this span.
                { # A named metric is a metric with name, value and unit.
                  &quot;name&quot;: &quot;A String&quot;, # The name of the metric.
                  &quot;unit&quot;: &quot;A String&quot;, # The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard.
                  &quot;value&quot;: &quot;&quot;, # The value of the metric.
                },
              ],
              &quot;name&quot;: &quot;A String&quot;, # The name of the span.
              &quot;startTime&quot;: &quot;A String&quot;, # Timestamp of the start of the span.
              &quot;tags&quot;: [ # The metadata tags of the span such as span type.
                &quot;A String&quot;,
              ],
            },
          ],
          &quot;toolUse&quot;: { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
            &quot;action&quot;: &quot;A String&quot;, # Optional. Name of the action to be called during the tool use.
            &quot;dataStoreToolTrace&quot;: { # The tracing information for the data store tool. # Optional. Data store tool trace.
              &quot;dataStoreConnectionSignals&quot;: { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals.
                &quot;answer&quot;: &quot;A String&quot;, # Optional. The final compiled answer.
                &quot;answerGenerationModelCallSignals&quot;: { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call.
                  &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
                  &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
                  &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
                },
                &quot;answerParts&quot;: [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces).
                  { # Answer part with citation.
                    &quot;supportingIndices&quot;: [ # Citations for this answer part. Indices of `search_snippets`.
                      42,
                    ],
                    &quot;text&quot;: &quot;A String&quot;, # Substring of the answer.
                  },
                ],
                &quot;citedSnippets&quot;: [ # Optional. Snippets cited by the answer generation model from the most to least relevant.
                  { # Snippet cited by the answer generation model.
                    &quot;searchSnippet&quot;: { # Search snippet details. # Details of the snippet.
                      &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                      &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                      &quot;metadata&quot;: { # Metadata associated with the document.
                        &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                      },
                      &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
                    },
                    &quot;snippetIndex&quot;: 42, # Index of the snippet in `search_snippets` field.
                  },
                ],
                &quot;groundingSignals&quot;: { # Grounding signals. # Optional. Grounding signals.
                  &quot;decision&quot;: &quot;A String&quot;, # Represents the decision of the grounding check.
                  &quot;score&quot;: &quot;A String&quot;, # Grounding score bucket setting.
                },
                &quot;rewriterModelCallSignals&quot;: { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call.
                  &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
                  &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
                  &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
                },
                &quot;rewrittenQuery&quot;: &quot;A String&quot;, # Optional. Rewritten string query used for search.
                &quot;safetySignals&quot;: { # Safety check results. # Optional. Safety check result.
                  &quot;bannedPhraseMatch&quot;: &quot;A String&quot;, # Specifies banned phrase match subject.
                  &quot;decision&quot;: &quot;A String&quot;, # Safety decision.
                  &quot;matchedBannedPhrase&quot;: &quot;A String&quot;, # The matched banned phrase if there was a match.
                },
                &quot;searchSnippets&quot;: [ # Optional. Search snippets included in the answer generation prompt.
                  { # Search snippet details.
                    &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                    &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                    &quot;metadata&quot;: { # Metadata associated with the document.
                      &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                    },
                    &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
                  },
                ],
              },
            },
            &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool.
            &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;tool&quot;: &quot;A String&quot;, # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
            &quot;webhookToolTrace&quot;: { # The tracing information for the webhook tool. # Optional. Webhook tool trace.
              &quot;webhookTag&quot;: &quot;A String&quot;, # Optional. The tag of the webhook.
              &quot;webhookUri&quot;: &quot;A String&quot;, # Optional. The url of the webhook.
            },
          },
          &quot;tts&quot;: { # Stores metadata of the Text-to-Speech action. # Optional. Text-to-speech action performed by the agent.
          },
          &quot;userUtterance&quot;: { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
            &quot;audio&quot;: &quot;A String&quot;, # Optional. Audio input.
            &quot;audioTokens&quot;: [ # Optional. Tokens of the audio input.
              42,
            ],
            &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
          },
        },
      ],
      &quot;conversationState&quot;: &quot;A String&quot;, # Required. Example&#x27;s output state.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial example creation.
      &quot;description&quot;: &quot;A String&quot;, # Optional. The high level concise description of the example. The max number of characters is 200.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the example.
      &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The language code of the example. If not specified, the agent&#x27;s default language is used. Note: languages must be enabled in the agent before they can be used. Note: example&#x27;s language code is not currently used in dialogflow agents.
      &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
      &quot;playbookInput&quot;: { # Input of the playbook. # Optional. The input to the playbook in the example.
        &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
      },
      &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. The output of the playbook in the example.
        &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
        },
        &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
        &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
      },
      &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current example takes when sent to the LLM.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the example was updated.
    },
  ],
  &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
  &quot;playbook&quot;: { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
    &quot;codeBlock&quot;: { # Represents a code block. # Optional. The playbook&#x27;s scoped code block, which may implement handlers and actions.
      &quot;code&quot;: &quot;A String&quot;, # Optional. Source code of the block in Python.
    },
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial playbook creation.
    &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the playbook, unique within an agent.
    &quot;goal&quot;: &quot;A String&quot;, # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it&#x27;s visible to other playbooks that may reference this playbook.
    &quot;handlers&quot;: [ # Optional. A list of registered handlers to execute based on the specified triggers.
      { # Handler can be used to define custom logic to be executed based on the user-specified triggers.
        &quot;eventHandler&quot;: { # A handler that is triggered by the specified event. # A handler triggered by event.
          &quot;condition&quot;: &quot;A String&quot;, # Optional. The condition that must be satisfied to trigger this handler.
          &quot;event&quot;: &quot;A String&quot;, # Required. The name of the event that triggers this handler.
          &quot;fulfillment&quot;: { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page&#x27;s entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to call when the event occurs.
            &quot;advancedSettings&quot;: { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent-&gt;Flow-&gt;Page-&gt;Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
              &quot;audioExportGcsDestination&quot;: { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
                &quot;uri&quot;: &quot;A String&quot;, # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
              },
              &quot;dtmfSettings&quot;: { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
                &quot;enabled&quot;: True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a &quot;3&quot; was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
                &quot;endpointingTimeoutDuration&quot;: &quot;A String&quot;, # Endpoint timeout setting for matching dtmf input to regex.
                &quot;finishDigit&quot;: &quot;A String&quot;, # The digit that terminates a DTMF digit sequence.
                &quot;interdigitTimeoutDuration&quot;: &quot;A String&quot;, # Interdigit timeout setting for matching dtmf input to regex.
                &quot;maxDigits&quot;: 42, # Max length of DTMF digits.
              },
              &quot;loggingSettings&quot;: { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
                &quot;enableConsentBasedRedaction&quot;: True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.
                &quot;enableInteractionLogging&quot;: True or False, # Enables DF Interaction logging.
                &quot;enableStackdriverLogging&quot;: True or False, # Enables Google Cloud Logging.
              },
              &quot;speechSettings&quot;: { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
                &quot;endpointerSensitivity&quot;: 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
                &quot;models&quot;: { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;noSpeechTimeout&quot;: &quot;A String&quot;, # Timeout before detecting no speech.
                &quot;useTimeoutBasedEndpointing&quot;: True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
              },
            },
            &quot;conditionalCases&quot;: [ # Conditional cases for this fulfillment.
              { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
                &quot;cases&quot;: [ # A list of cascading if-else conditions.
                  { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
                    &quot;caseContent&quot;: [ # A list of case content.
                      { # The list of messages or conditional cases to activate for this case.
                        &quot;additionalCases&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
                        &quot;message&quot;: { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message.
                          &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                          &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                            &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                          },
                          &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                          },
                          &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                          },
                          &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                            &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                          },
                          &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                            &quot;segments&quot;: [ # Segments this audio response is composed of.
                              { # Represents one segment of audio.
                                &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                                &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                                &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                              },
                            ],
                          },
                          &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                            &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                          },
                          &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                          },
                          &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                          },
                          &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                            &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                          },
                          &quot;text&quot;: { # The text response message. # Returns a text response.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                              &quot;A String&quot;,
                            ],
                          },
                          &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                            &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                            &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                            &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                          },
                        },
                      },
                    ],
                    &quot;condition&quot;: &quot;A String&quot;, # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
                  },
                ],
              },
            ],
            &quot;enableGenerativeFallback&quot;: True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
            &quot;generators&quot;: [ # A list of Generators to be called during this fulfillment.
              { # Generator settings used by the LLM to generate a text response.
                &quot;generator&quot;: &quot;A String&quot;, # Required. The generator to call. Format: `projects//locations//agents//generators/`.
                &quot;inputParameters&quot;: { # Map from placeholder parameter in the Generator to corresponding session parameters. By default, Dialogflow uses the session parameter with the same name to fill in the generator template. e.g. If there is a placeholder parameter `city` in the Generator, Dialogflow default to fill in the `$city` with `$session.params.city`. However, you may choose to fill `$city` with `$session.params.desination-city`. - Map key: parameter ID - Map value: session parameter name
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;outputParameter&quot;: &quot;A String&quot;, # Required. Output parameter which should contain the generator response.
              },
            ],
            &quot;messages&quot;: [ # The list of rich message responses to present to the user.
              { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.
                &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                  &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                },
                &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                },
                &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                },
                &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                  &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                },
                &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                  &quot;segments&quot;: [ # Segments this audio response is composed of.
                    { # Represents one segment of audio.
                      &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                      &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                      &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                    },
                  ],
                },
                &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                  &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                },
                &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                },
                &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                  &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                },
                &quot;text&quot;: { # The text response message. # Returns a text response.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                    &quot;A String&quot;,
                  ],
                },
                &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                  &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                  &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                  &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                },
              },
            ],
            &quot;returnPartialResponses&quot;: True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
            &quot;setParameterActions&quot;: [ # Set parameter values before executing the webhook.
              { # Setting a parameter value.
                &quot;parameter&quot;: &quot;A String&quot;, # Display name of the parameter.
                &quot;value&quot;: &quot;&quot;, # The new value of the parameter. A null value clears the parameter.
              },
            ],
            &quot;tag&quot;: &quot;A String&quot;, # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
            &quot;webhook&quot;: &quot;A String&quot;, # The webhook to call. Format: `projects//locations//agents//webhooks/`.
          },
        },
        &quot;lifecycleHandler&quot;: { # A handler that is triggered on the specific lifecycle_stage of the playbook execution. # A handler triggered during specific lifecycle of the playbook execution.
          &quot;condition&quot;: &quot;A String&quot;, # Optional. The condition that must be satisfied to trigger this handler.
          &quot;fulfillment&quot;: { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page&#x27;s entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to call when this handler is triggered.
            &quot;advancedSettings&quot;: { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent-&gt;Flow-&gt;Page-&gt;Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
              &quot;audioExportGcsDestination&quot;: { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
                &quot;uri&quot;: &quot;A String&quot;, # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
              },
              &quot;dtmfSettings&quot;: { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
                &quot;enabled&quot;: True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a &quot;3&quot; was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
                &quot;endpointingTimeoutDuration&quot;: &quot;A String&quot;, # Endpoint timeout setting for matching dtmf input to regex.
                &quot;finishDigit&quot;: &quot;A String&quot;, # The digit that terminates a DTMF digit sequence.
                &quot;interdigitTimeoutDuration&quot;: &quot;A String&quot;, # Interdigit timeout setting for matching dtmf input to regex.
                &quot;maxDigits&quot;: 42, # Max length of DTMF digits.
              },
              &quot;loggingSettings&quot;: { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
                &quot;enableConsentBasedRedaction&quot;: True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.
                &quot;enableInteractionLogging&quot;: True or False, # Enables DF Interaction logging.
                &quot;enableStackdriverLogging&quot;: True or False, # Enables Google Cloud Logging.
              },
              &quot;speechSettings&quot;: { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
                &quot;endpointerSensitivity&quot;: 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
                &quot;models&quot;: { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;noSpeechTimeout&quot;: &quot;A String&quot;, # Timeout before detecting no speech.
                &quot;useTimeoutBasedEndpointing&quot;: True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
              },
            },
            &quot;conditionalCases&quot;: [ # Conditional cases for this fulfillment.
              { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
                &quot;cases&quot;: [ # A list of cascading if-else conditions.
                  { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
                    &quot;caseContent&quot;: [ # A list of case content.
                      { # The list of messages or conditional cases to activate for this case.
                        &quot;additionalCases&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
                        &quot;message&quot;: { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message.
                          &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                          &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                            &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                          },
                          &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                          },
                          &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                          },
                          &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                            &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                          },
                          &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                            &quot;segments&quot;: [ # Segments this audio response is composed of.
                              { # Represents one segment of audio.
                                &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                                &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                                &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                              },
                            ],
                          },
                          &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                            &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                          },
                          &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                          },
                          &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                          },
                          &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                            &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                          },
                          &quot;text&quot;: { # The text response message. # Returns a text response.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                              &quot;A String&quot;,
                            ],
                          },
                          &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                            &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                            &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                            &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                          },
                        },
                      },
                    ],
                    &quot;condition&quot;: &quot;A String&quot;, # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
                  },
                ],
              },
            ],
            &quot;enableGenerativeFallback&quot;: True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
            &quot;generators&quot;: [ # A list of Generators to be called during this fulfillment.
              { # Generator settings used by the LLM to generate a text response.
                &quot;generator&quot;: &quot;A String&quot;, # Required. The generator to call. Format: `projects//locations//agents//generators/`.
                &quot;inputParameters&quot;: { # Map from placeholder parameter in the Generator to corresponding session parameters. By default, Dialogflow uses the session parameter with the same name to fill in the generator template. e.g. If there is a placeholder parameter `city` in the Generator, Dialogflow default to fill in the `$city` with `$session.params.city`. However, you may choose to fill `$city` with `$session.params.desination-city`. - Map key: parameter ID - Map value: session parameter name
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;outputParameter&quot;: &quot;A String&quot;, # Required. Output parameter which should contain the generator response.
              },
            ],
            &quot;messages&quot;: [ # The list of rich message responses to present to the user.
              { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.
                &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                  &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                },
                &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                },
                &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                },
                &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                  &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                },
                &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                  &quot;segments&quot;: [ # Segments this audio response is composed of.
                    { # Represents one segment of audio.
                      &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                      &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                      &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                    },
                  ],
                },
                &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                  &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                },
                &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                },
                &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                  &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                },
                &quot;text&quot;: { # The text response message. # Returns a text response.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                    &quot;A String&quot;,
                  ],
                },
                &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                  &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                  &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                  &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                },
              },
            ],
            &quot;returnPartialResponses&quot;: True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
            &quot;setParameterActions&quot;: [ # Set parameter values before executing the webhook.
              { # Setting a parameter value.
                &quot;parameter&quot;: &quot;A String&quot;, # Display name of the parameter.
                &quot;value&quot;: &quot;&quot;, # The new value of the parameter. A null value clears the parameter.
              },
            ],
            &quot;tag&quot;: &quot;A String&quot;, # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
            &quot;webhook&quot;: &quot;A String&quot;, # The webhook to call. Format: `projects//locations//agents//webhooks/`.
          },
          &quot;lifecycleStage&quot;: &quot;A String&quot;, # Required. The name of the lifecycle stage that triggers this handler. Supported values: * `playbook-start` * `pre-action-selection` * `pre-action-execution`
        },
      },
    ],
    &quot;inlineActions&quot;: [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook&#x27;s code block.
      &quot;A String&quot;,
    ],
    &quot;inputParameterDefinitions&quot;: [ # Optional. Defined structured input parameters for this playbook.
      { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
        &quot;description&quot;: &quot;A String&quot;, # Human-readable description of the parameter. Limited to 300 characters.
        &quot;name&quot;: &quot;A String&quot;, # Required. Name of parameter.
        &quot;type&quot;: &quot;A String&quot;, # Type of parameter.
        &quot;typeSchema&quot;: { # Encapsulates different type schema variations: either a reference to an a schema that&#x27;s already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
          &quot;inlineSchema&quot;: { # A type schema object that&#x27;s specified inline. # Set if this is an inline schema definition.
            &quot;items&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
            &quot;type&quot;: &quot;A String&quot;, # Data type of the schema.
          },
          &quot;schemaReference&quot;: { # A reference to the schema of an existing tool. # Set if this is a schema reference.
            &quot;schema&quot;: &quot;A String&quot;, # The name of the schema.
            &quot;tool&quot;: &quot;A String&quot;, # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
          },
        },
      },
    ],
    &quot;instruction&quot;: { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
      &quot;guidelines&quot;: &quot;A String&quot;, # General guidelines for the playbook. These are unstructured instructions that are not directly part of the goal, e.g. &quot;Always be polite&quot;. It&#x27;s valid for this text to be long and used instead of steps altogether.
      &quot;steps&quot;: [ # Ordered list of step by step execution instructions to accomplish target goal.
        { # Message of single step execution.
          &quot;steps&quot;: [ # Sub-processing needed to execute the current step.
            # Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
          ],
          &quot;text&quot;: &quot;A String&quot;, # Step instruction in text format.
        },
      ],
    },
    &quot;llmModelSettings&quot;: { # Settings for LLM models. # Optional. Llm model settings for the playbook.
      &quot;model&quot;: &quot;A String&quot;, # The selected LLM model.
      &quot;parameters&quot;: { # Generative model parameters to control the model behavior. # Generative model parameters.
        &quot;inputTokenLimit&quot;: &quot;A String&quot;, # The input token limit. This setting is currently only supported by playbooks.
        &quot;outputTokenLimit&quot;: &quot;A String&quot;, # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set.
        &quot;temperature&quot;: 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0]
      },
      &quot;promptText&quot;: &quot;A String&quot;, # The custom prompt to use.
    },
    &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
    &quot;outputParameterDefinitions&quot;: [ # Optional. Defined structured output parameters for this playbook.
      { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
        &quot;description&quot;: &quot;A String&quot;, # Human-readable description of the parameter. Limited to 300 characters.
        &quot;name&quot;: &quot;A String&quot;, # Required. Name of parameter.
        &quot;type&quot;: &quot;A String&quot;, # Type of parameter.
        &quot;typeSchema&quot;: { # Encapsulates different type schema variations: either a reference to an a schema that&#x27;s already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
          &quot;inlineSchema&quot;: { # A type schema object that&#x27;s specified inline. # Set if this is an inline schema definition.
            &quot;items&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
            &quot;type&quot;: &quot;A String&quot;, # Data type of the schema.
          },
          &quot;schemaReference&quot;: { # A reference to the schema of an existing tool. # Set if this is a schema reference.
            &quot;schema&quot;: &quot;A String&quot;, # The name of the schema.
            &quot;tool&quot;: &quot;A String&quot;, # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
          },
        },
      },
    ],
    &quot;playbookType&quot;: &quot;A String&quot;, # Optional. Type of the playbook.
    &quot;referencedFlows&quot;: [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
      &quot;A String&quot;,
    ],
    &quot;referencedPlaybooks&quot;: [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
      &quot;A String&quot;,
    ],
    &quot;referencedTools&quot;: [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
      &quot;A String&quot;,
    ],
    &quot;speechSettings&quot;: { # Define behaviors of speech to text detection. # Optional. Playbook level Settings for speech to text detection.
      &quot;endpointerSensitivity&quot;: 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
      &quot;models&quot;: { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;noSpeechTimeout&quot;: &quot;A String&quot;, # Timeout before detecting no speech.
      &quot;useTimeoutBasedEndpointing&quot;: True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
    },
    &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the playbook version was updated.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the playbook version was created or modified.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists versions for the specified Playbook.

Args:
  parent: string, Required. The playbook to list versions for. Format: `projects//locations//agents//playbooks/`. (required)
  pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
  pageToken: string, Optional. The next_page_token value returned from a previous list request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for Playbooks.ListPlaybookVersions.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
  &quot;playbookVersions&quot;: [ # The list of playbook version. There will be a maximum number of items returned based on the page_size field in the request.
    { # Playbook version is a snapshot of the playbook at certain timestamp.
      &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the playbook version.
      &quot;examples&quot;: [ # Output only. Snapshot of the examples belonging to the playbook when the playbook version is created.
        { # Example represents a sample execution of the playbook in the conversation. An example consists of a list of ordered actions performed by end user or Dialogflow agent according the playbook instructions to fulfill the task.
          &quot;actions&quot;: [ # Required. The ordered list of actions performed by the end user and the Dialogflow agent.
            { # Action performed by end user or Dialogflow agent in the conversation.
              &quot;agentUtterance&quot;: { # AgentUtterance represents one message sent by the agent. # Optional. Action performed by the agent as a message.
                &quot;requireGeneration&quot;: True or False, # Optional. True if the agent utterance needs to be generated by the LLM. Only used in webhook response to differentiate from empty text. Revisit whether we need this field or mark `text` as optional when we expose webhook interface to customer.
                &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
              },
              &quot;completeTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the completion of the agent action.
              &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the action.
              &quot;event&quot;: { # Event represents the event sent by the customer. # Optional. The agent received an event from the customer or a system event is emitted.
                &quot;event&quot;: &quot;A String&quot;, # Required. Name of the event.
                &quot;text&quot;: &quot;A String&quot;, # Optional. Unstructured text payload of the event.
              },
              &quot;flowInvocation&quot;: { # Stores metadata of the invocation of a child CX flow. Flow invocation actions enter the child flow. # Optional. Action performed on behalf of the agent by invoking a CX flow.
                &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
                &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
                &quot;flowState&quot;: &quot;A String&quot;, # Required. Flow invocation&#x27;s output state.
                &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the flow.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the flow invocation.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
              },
              &quot;flowStateUpdate&quot;: { # Stores metadata of the state update action, such as a state machine execution in flows. # Optional. Output only. The state machine update in flows.
                &quot;destination&quot;: &quot;A String&quot;, # The destination of the transition. Format: `projects//locations//agents//flows//pages/` or `projects//locations//agents//playbooks/`.
                &quot;eventType&quot;: &quot;A String&quot;, # The type of the event that triggered the state update.
                &quot;functionCall&quot;: { # Stores the metadata of a function call to execute. # The function call to execute.
                  &quot;name&quot;: &quot;A String&quot;, # The name of the function call.
                },
                &quot;pageState&quot;: { # Stores the state of a page and its flow. # The updated page and flow state.
                  &quot;displayName&quot;: &quot;A String&quot;, # The display name of the page.
                  &quot;page&quot;: &quot;A String&quot;, # The ID of the page. Format: `projects//locations//agents//flows//pages/`.
                  &quot;status&quot;: &quot;A String&quot;, # The status of the page.
                },
                &quot;updatedParameters&quot;: { # The updated parameters.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
              },
              &quot;flowTransition&quot;: { # Stores metadata of the transition to a target CX flow. Flow transition actions exit the caller playbook and enter the child flow. # Optional. Action performed on behalf of the agent by transitioning to a target CX flow.
                &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the flow.
                &quot;flow&quot;: &quot;A String&quot;, # Required. The unique identifier of the flow. Format: `projects//locations//agents/`.
                &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
              },
              &quot;intentMatch&quot;: { # Stores metadata of the intent match action. # Optional. Output only. Intent Match in flows.
                &quot;matchedIntents&quot;: [ # The matched intent.
                  { # Stores the matched intent, which is the result of the intent match action.
                    &quot;displayName&quot;: &quot;A String&quot;, # The display name of the matched intent.
                    &quot;generativeFallback&quot;: { # The generative fallback response of the matched intent.
                      &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                    },
                    &quot;intentId&quot;: &quot;A String&quot;, # The ID of the matched intent.
                    &quot;score&quot;: 3.14, # The score of the matched intent.
                  },
                ],
              },
              &quot;llmCall&quot;: { # Stores metadata of the call of an LLM. # Optional. Output only. LLM call performed by the agent.
                &quot;model&quot;: &quot;A String&quot;, # The model of the LLM call.
                &quot;retrievedExamples&quot;: [ # A list of relevant examples used for the LLM prompt.
                  { # Relevant example used for the LLM prompt.
                    &quot;exampleDisplayName&quot;: &quot;A String&quot;, # The display name of the example.
                    &quot;exampleId&quot;: &quot;A String&quot;, # The id of the example.
                    &quot;matchedRetrievalLabel&quot;: &quot;A String&quot;, # Optional. The matched retrieval label of this LLM call.
                    &quot;retrievalStrategy&quot;: &quot;A String&quot;, # Retrieval strategy of the example.
                  },
                ],
                &quot;temperature&quot;: 3.14, # The temperature of the LLM call.
                &quot;tokenCount&quot;: { # Stores token counts of the LLM call. # The token counts of the LLM call.
                  &quot;conversationContextTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the conversation history in the prompt.
                  &quot;exampleTokenCount&quot;: &quot;A String&quot;, # The number of tokens used for the retrieved examples in the prompt.
                  &quot;totalInputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the input to the LLM call.
                  &quot;totalOutputTokenCount&quot;: &quot;A String&quot;, # The total number of tokens used for the output of the LLM call.
                },
              },
              &quot;playbookInvocation&quot;: { # Stores metadata of the invocation of a child playbook. Playbook invocation actions enter the child playbook. # Optional. Action performed on behalf of the agent by invoking a child playbook.
                &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
                &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
                &quot;playbookInput&quot;: { # Input of the playbook. # Optional. Input of the child playbook invocation.
                  &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                  &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
                },
                &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. Output of the child playbook invocation.
                  &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                  &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
                  &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
                },
                &quot;playbookState&quot;: &quot;A String&quot;, # Required. Playbook invocation&#x27;s output state.
              },
              &quot;playbookTransition&quot;: { # Stores metadata of the transition to another target playbook. Playbook transition actions exit the caller playbook and enter the target playbook. # Optional. Action performed on behalf of the agent by transitioning to a target playbook.
                &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the playbook.
                &quot;inputActionParameters&quot;: { # A list of input parameters for the action.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;playbook&quot;: &quot;A String&quot;, # Required. The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
              },
              &quot;startTime&quot;: &quot;A String&quot;, # Output only. Timestamp of the start of the agent action.
              &quot;status&quot;: { # The status of the action. # Optional. Output only. The status of the action.
                &quot;exception&quot;: { # Exception thrown during the execution of an action. # Optional. The exception thrown during the execution of the action.
                  &quot;errorMessage&quot;: &quot;A String&quot;, # Optional. The error message.
                },
              },
              &quot;stt&quot;: { # Stores metadata of the Speech-to-Text action. # Optional. Speech-to-text action performed by the agent.
              },
              &quot;subExecutionSteps&quot;: [ # Optional. The detailed tracing information for sub execution steps of the action.
                { # A span represents a sub execution step of an action.
                  &quot;completeTime&quot;: &quot;A String&quot;, # Timestamp of the completion of the span.
                  &quot;metrics&quot;: [ # The unordered collection of metrics in this span.
                    { # A named metric is a metric with name, value and unit.
                      &quot;name&quot;: &quot;A String&quot;, # The name of the metric.
                      &quot;unit&quot;: &quot;A String&quot;, # The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard.
                      &quot;value&quot;: &quot;&quot;, # The value of the metric.
                    },
                  ],
                  &quot;name&quot;: &quot;A String&quot;, # The name of the span.
                  &quot;startTime&quot;: &quot;A String&quot;, # Timestamp of the start of the span.
                  &quot;tags&quot;: [ # The metadata tags of the span such as span type.
                    &quot;A String&quot;,
                  ],
                },
              ],
              &quot;toolUse&quot;: { # Stores metadata of the invocation of an action supported by a tool. # Optional. Action performed on behalf of the agent by calling a plugin tool.
                &quot;action&quot;: &quot;A String&quot;, # Optional. Name of the action to be called during the tool use.
                &quot;dataStoreToolTrace&quot;: { # The tracing information for the data store tool. # Optional. Data store tool trace.
                  &quot;dataStoreConnectionSignals&quot;: { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals.
                    &quot;answer&quot;: &quot;A String&quot;, # Optional. The final compiled answer.
                    &quot;answerGenerationModelCallSignals&quot;: { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call.
                      &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
                      &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
                      &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
                    },
                    &quot;answerParts&quot;: [ # Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces).
                      { # Answer part with citation.
                        &quot;supportingIndices&quot;: [ # Citations for this answer part. Indices of `search_snippets`.
                          42,
                        ],
                        &quot;text&quot;: &quot;A String&quot;, # Substring of the answer.
                      },
                    ],
                    &quot;citedSnippets&quot;: [ # Optional. Snippets cited by the answer generation model from the most to least relevant.
                      { # Snippet cited by the answer generation model.
                        &quot;searchSnippet&quot;: { # Search snippet details. # Details of the snippet.
                          &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                          &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                          &quot;metadata&quot;: { # Metadata associated with the document.
                            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                          },
                          &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
                        },
                        &quot;snippetIndex&quot;: 42, # Index of the snippet in `search_snippets` field.
                      },
                    ],
                    &quot;groundingSignals&quot;: { # Grounding signals. # Optional. Grounding signals.
                      &quot;decision&quot;: &quot;A String&quot;, # Represents the decision of the grounding check.
                      &quot;score&quot;: &quot;A String&quot;, # Grounding score bucket setting.
                    },
                    &quot;rewriterModelCallSignals&quot;: { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call.
                      &quot;model&quot;: &quot;A String&quot;, # Name of the generative model. For example, &quot;gemini-ultra&quot;, &quot;gemini-pro&quot;, &quot;gemini-1.5-flash&quot; etc. Defaults to &quot;Other&quot; if the model is unknown.
                      &quot;modelOutput&quot;: &quot;A String&quot;, # Output of the generative model.
                      &quot;renderedPrompt&quot;: &quot;A String&quot;, # Prompt as sent to the model.
                    },
                    &quot;rewrittenQuery&quot;: &quot;A String&quot;, # Optional. Rewritten string query used for search.
                    &quot;safetySignals&quot;: { # Safety check results. # Optional. Safety check result.
                      &quot;bannedPhraseMatch&quot;: &quot;A String&quot;, # Specifies banned phrase match subject.
                      &quot;decision&quot;: &quot;A String&quot;, # Safety decision.
                      &quot;matchedBannedPhrase&quot;: &quot;A String&quot;, # The matched banned phrase if there was a match.
                    },
                    &quot;searchSnippets&quot;: [ # Optional. Search snippets included in the answer generation prompt.
                      { # Search snippet details.
                        &quot;documentTitle&quot;: &quot;A String&quot;, # Title of the enclosing document.
                        &quot;documentUri&quot;: &quot;A String&quot;, # Uri for the document. Present if specified for the document.
                        &quot;metadata&quot;: { # Metadata associated with the document.
                          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                        },
                        &quot;text&quot;: &quot;A String&quot;, # Text included in the prompt.
                      },
                    ],
                  },
                },
                &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the tool.
                &quot;inputActionParameters&quot;: { # Optional. A list of input parameters for the action.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;outputActionParameters&quot;: { # Optional. A list of output parameters generated by the action.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;tool&quot;: &quot;A String&quot;, # Required. The tool that should be used. Format: `projects//locations//agents//tools/`.
                &quot;webhookToolTrace&quot;: { # The tracing information for the webhook tool. # Optional. Webhook tool trace.
                  &quot;webhookTag&quot;: &quot;A String&quot;, # Optional. The tag of the webhook.
                  &quot;webhookUri&quot;: &quot;A String&quot;, # Optional. The url of the webhook.
                },
              },
              &quot;tts&quot;: { # Stores metadata of the Text-to-Speech action. # Optional. Text-to-speech action performed by the agent.
              },
              &quot;userUtterance&quot;: { # UserUtterance represents one message sent by the customer. # Optional. Agent obtained a message from the customer.
                &quot;audio&quot;: &quot;A String&quot;, # Optional. Audio input.
                &quot;audioTokens&quot;: [ # Optional. Tokens of the audio input.
                  42,
                ],
                &quot;text&quot;: &quot;A String&quot;, # Required. Message content in text.
              },
            },
          ],
          &quot;conversationState&quot;: &quot;A String&quot;, # Required. Example&#x27;s output state.
          &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial example creation.
          &quot;description&quot;: &quot;A String&quot;, # Optional. The high level concise description of the example. The max number of characters is 200.
          &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the example.
          &quot;languageCode&quot;: &quot;A String&quot;, # Optional. The language code of the example. If not specified, the agent&#x27;s default language is used. Note: languages must be enabled in the agent before they can be used. Note: example&#x27;s language code is not currently used in dialogflow agents.
          &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook example. Format: `projects//locations//agents//playbooks//examples/`.
          &quot;playbookInput&quot;: { # Input of the playbook. # Optional. The input to the playbook in the example.
            &quot;actionParameters&quot;: { # Optional. A list of input parameters for the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;precedingConversationSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the preceding conversation for the child playbook invocation.
          },
          &quot;playbookOutput&quot;: { # Output of the playbook. # Optional. The output of the playbook in the example.
            &quot;actionParameters&quot;: { # Optional. A Struct object of output parameters for the action.
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
            },
            &quot;executionSummary&quot;: &quot;A String&quot;, # Optional. Summary string of the execution result of the child playbook.
            &quot;state&quot;: &quot;A String&quot;, # End state of the playbook.
          },
          &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current example takes when sent to the LLM.
          &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the example was updated.
        },
      ],
      &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
      &quot;playbook&quot;: { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
        &quot;codeBlock&quot;: { # Represents a code block. # Optional. The playbook&#x27;s scoped code block, which may implement handlers and actions.
          &quot;code&quot;: &quot;A String&quot;, # Optional. Source code of the block in Python.
        },
        &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial playbook creation.
        &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the playbook, unique within an agent.
        &quot;goal&quot;: &quot;A String&quot;, # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it&#x27;s visible to other playbooks that may reference this playbook.
        &quot;handlers&quot;: [ # Optional. A list of registered handlers to execute based on the specified triggers.
          { # Handler can be used to define custom logic to be executed based on the user-specified triggers.
            &quot;eventHandler&quot;: { # A handler that is triggered by the specified event. # A handler triggered by event.
              &quot;condition&quot;: &quot;A String&quot;, # Optional. The condition that must be satisfied to trigger this handler.
              &quot;event&quot;: &quot;A String&quot;, # Required. The name of the event that triggers this handler.
              &quot;fulfillment&quot;: { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page&#x27;s entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to call when the event occurs.
                &quot;advancedSettings&quot;: { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent-&gt;Flow-&gt;Page-&gt;Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
                  &quot;audioExportGcsDestination&quot;: { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
                    &quot;uri&quot;: &quot;A String&quot;, # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
                  },
                  &quot;dtmfSettings&quot;: { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
                    &quot;enabled&quot;: True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a &quot;3&quot; was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
                    &quot;endpointingTimeoutDuration&quot;: &quot;A String&quot;, # Endpoint timeout setting for matching dtmf input to regex.
                    &quot;finishDigit&quot;: &quot;A String&quot;, # The digit that terminates a DTMF digit sequence.
                    &quot;interdigitTimeoutDuration&quot;: &quot;A String&quot;, # Interdigit timeout setting for matching dtmf input to regex.
                    &quot;maxDigits&quot;: 42, # Max length of DTMF digits.
                  },
                  &quot;loggingSettings&quot;: { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
                    &quot;enableConsentBasedRedaction&quot;: True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.
                    &quot;enableInteractionLogging&quot;: True or False, # Enables DF Interaction logging.
                    &quot;enableStackdriverLogging&quot;: True or False, # Enables Google Cloud Logging.
                  },
                  &quot;speechSettings&quot;: { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
                    &quot;endpointerSensitivity&quot;: 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
                    &quot;models&quot;: { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
                      &quot;a_key&quot;: &quot;A String&quot;,
                    },
                    &quot;noSpeechTimeout&quot;: &quot;A String&quot;, # Timeout before detecting no speech.
                    &quot;useTimeoutBasedEndpointing&quot;: True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
                  },
                },
                &quot;conditionalCases&quot;: [ # Conditional cases for this fulfillment.
                  { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
                    &quot;cases&quot;: [ # A list of cascading if-else conditions.
                      { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
                        &quot;caseContent&quot;: [ # A list of case content.
                          { # The list of messages or conditional cases to activate for this case.
                            &quot;additionalCases&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
                            &quot;message&quot;: { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message.
                              &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                              &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                                &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                                },
                              },
                              &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                              },
                              &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                              },
                              &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                                &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                                },
                              },
                              &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                                &quot;segments&quot;: [ # Segments this audio response is composed of.
                                  { # Represents one segment of audio.
                                    &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                                    &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                                    &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                                  },
                                ],
                              },
                              &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                                &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                                &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                                &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                              },
                              &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                                &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                              },
                              &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                                &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                                &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                              },
                              &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                                &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                              },
                              &quot;text&quot;: { # The text response message. # Returns a text response.
                                &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                                &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                                  &quot;A String&quot;,
                                ],
                              },
                              &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                                &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                                &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                                },
                                &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                              },
                            },
                          },
                        ],
                        &quot;condition&quot;: &quot;A String&quot;, # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
                      },
                    ],
                  },
                ],
                &quot;enableGenerativeFallback&quot;: True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
                &quot;generators&quot;: [ # A list of Generators to be called during this fulfillment.
                  { # Generator settings used by the LLM to generate a text response.
                    &quot;generator&quot;: &quot;A String&quot;, # Required. The generator to call. Format: `projects//locations//agents//generators/`.
                    &quot;inputParameters&quot;: { # Map from placeholder parameter in the Generator to corresponding session parameters. By default, Dialogflow uses the session parameter with the same name to fill in the generator template. e.g. If there is a placeholder parameter `city` in the Generator, Dialogflow default to fill in the `$city` with `$session.params.city`. However, you may choose to fill `$city` with `$session.params.desination-city`. - Map key: parameter ID - Map value: session parameter name
                      &quot;a_key&quot;: &quot;A String&quot;,
                    },
                    &quot;outputParameter&quot;: &quot;A String&quot;, # Required. Output parameter which should contain the generator response.
                  },
                ],
                &quot;messages&quot;: [ # The list of rich message responses to present to the user.
                  { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.
                    &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                    &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                      &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                        &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                      },
                    },
                    &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                    },
                    &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                    },
                    &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                      &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                        &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                      },
                    },
                    &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                      &quot;segments&quot;: [ # Segments this audio response is composed of.
                        { # Represents one segment of audio.
                          &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                          &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                          &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                        },
                      ],
                    },
                    &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                      &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                      &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                      &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                    },
                    &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                      &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                    },
                    &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                      &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                      &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                    },
                    &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                      &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                    },
                    &quot;text&quot;: { # The text response message. # Returns a text response.
                      &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                      &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                        &quot;A String&quot;,
                      ],
                    },
                    &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                      &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                      &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                        &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                      },
                      &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                    },
                  },
                ],
                &quot;returnPartialResponses&quot;: True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
                &quot;setParameterActions&quot;: [ # Set parameter values before executing the webhook.
                  { # Setting a parameter value.
                    &quot;parameter&quot;: &quot;A String&quot;, # Display name of the parameter.
                    &quot;value&quot;: &quot;&quot;, # The new value of the parameter. A null value clears the parameter.
                  },
                ],
                &quot;tag&quot;: &quot;A String&quot;, # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
                &quot;webhook&quot;: &quot;A String&quot;, # The webhook to call. Format: `projects//locations//agents//webhooks/`.
              },
            },
            &quot;lifecycleHandler&quot;: { # A handler that is triggered on the specific lifecycle_stage of the playbook execution. # A handler triggered during specific lifecycle of the playbook execution.
              &quot;condition&quot;: &quot;A String&quot;, # Optional. The condition that must be satisfied to trigger this handler.
              &quot;fulfillment&quot;: { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page&#x27;s entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to call when this handler is triggered.
                &quot;advancedSettings&quot;: { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent-&gt;Flow-&gt;Page-&gt;Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
                  &quot;audioExportGcsDestination&quot;: { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
                    &quot;uri&quot;: &quot;A String&quot;, # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
                  },
                  &quot;dtmfSettings&quot;: { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
                    &quot;enabled&quot;: True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a &quot;3&quot; was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
                    &quot;endpointingTimeoutDuration&quot;: &quot;A String&quot;, # Endpoint timeout setting for matching dtmf input to regex.
                    &quot;finishDigit&quot;: &quot;A String&quot;, # The digit that terminates a DTMF digit sequence.
                    &quot;interdigitTimeoutDuration&quot;: &quot;A String&quot;, # Interdigit timeout setting for matching dtmf input to regex.
                    &quot;maxDigits&quot;: 42, # Max length of DTMF digits.
                  },
                  &quot;loggingSettings&quot;: { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
                    &quot;enableConsentBasedRedaction&quot;: True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.
                    &quot;enableInteractionLogging&quot;: True or False, # Enables DF Interaction logging.
                    &quot;enableStackdriverLogging&quot;: True or False, # Enables Google Cloud Logging.
                  },
                  &quot;speechSettings&quot;: { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
                    &quot;endpointerSensitivity&quot;: 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
                    &quot;models&quot;: { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
                      &quot;a_key&quot;: &quot;A String&quot;,
                    },
                    &quot;noSpeechTimeout&quot;: &quot;A String&quot;, # Timeout before detecting no speech.
                    &quot;useTimeoutBasedEndpointing&quot;: True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
                  },
                },
                &quot;conditionalCases&quot;: [ # Conditional cases for this fulfillment.
                  { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
                    &quot;cases&quot;: [ # A list of cascading if-else conditions.
                      { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
                        &quot;caseContent&quot;: [ # A list of case content.
                          { # The list of messages or conditional cases to activate for this case.
                            &quot;additionalCases&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
                            &quot;message&quot;: { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message.
                              &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                              &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                                &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                                },
                              },
                              &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                              },
                              &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                              },
                              &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                                &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                                },
                              },
                              &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                                &quot;segments&quot;: [ # Segments this audio response is composed of.
                                  { # Represents one segment of audio.
                                    &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                                    &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                                    &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                                  },
                                ],
                              },
                              &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                                &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                                &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                                &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                              },
                              &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                                &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                              },
                              &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                                &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                                &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                              },
                              &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                                &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                              },
                              &quot;text&quot;: { # The text response message. # Returns a text response.
                                &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                                &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                                  &quot;A String&quot;,
                                ],
                              },
                              &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                                &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                                &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                                },
                                &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                              },
                            },
                          },
                        ],
                        &quot;condition&quot;: &quot;A String&quot;, # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
                      },
                    ],
                  },
                ],
                &quot;enableGenerativeFallback&quot;: True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
                &quot;generators&quot;: [ # A list of Generators to be called during this fulfillment.
                  { # Generator settings used by the LLM to generate a text response.
                    &quot;generator&quot;: &quot;A String&quot;, # Required. The generator to call. Format: `projects//locations//agents//generators/`.
                    &quot;inputParameters&quot;: { # Map from placeholder parameter in the Generator to corresponding session parameters. By default, Dialogflow uses the session parameter with the same name to fill in the generator template. e.g. If there is a placeholder parameter `city` in the Generator, Dialogflow default to fill in the `$city` with `$session.params.city`. However, you may choose to fill `$city` with `$session.params.desination-city`. - Map key: parameter ID - Map value: session parameter name
                      &quot;a_key&quot;: &quot;A String&quot;,
                    },
                    &quot;outputParameter&quot;: &quot;A String&quot;, # Required. Output parameter which should contain the generator response.
                  },
                ],
                &quot;messages&quot;: [ # The list of rich message responses to present to the user.
                  { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.
                    &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                    &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                      &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                        &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                      },
                    },
                    &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                    },
                    &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                    },
                    &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                      &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                        &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                      },
                    },
                    &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                      &quot;segments&quot;: [ # Segments this audio response is composed of.
                        { # Represents one segment of audio.
                          &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                          &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                          &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                        },
                      ],
                    },
                    &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                      &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                      &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                      &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                    },
                    &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                      &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                    },
                    &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                      &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                      &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                    },
                    &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                      &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                    },
                    &quot;text&quot;: { # The text response message. # Returns a text response.
                      &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                      &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                        &quot;A String&quot;,
                      ],
                    },
                    &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                      &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                      &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                        &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                      },
                      &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                    },
                  },
                ],
                &quot;returnPartialResponses&quot;: True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
                &quot;setParameterActions&quot;: [ # Set parameter values before executing the webhook.
                  { # Setting a parameter value.
                    &quot;parameter&quot;: &quot;A String&quot;, # Display name of the parameter.
                    &quot;value&quot;: &quot;&quot;, # The new value of the parameter. A null value clears the parameter.
                  },
                ],
                &quot;tag&quot;: &quot;A String&quot;, # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
                &quot;webhook&quot;: &quot;A String&quot;, # The webhook to call. Format: `projects//locations//agents//webhooks/`.
              },
              &quot;lifecycleStage&quot;: &quot;A String&quot;, # Required. The name of the lifecycle stage that triggers this handler. Supported values: * `playbook-start` * `pre-action-selection` * `pre-action-execution`
            },
          },
        ],
        &quot;inlineActions&quot;: [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook&#x27;s code block.
          &quot;A String&quot;,
        ],
        &quot;inputParameterDefinitions&quot;: [ # Optional. Defined structured input parameters for this playbook.
          { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
            &quot;description&quot;: &quot;A String&quot;, # Human-readable description of the parameter. Limited to 300 characters.
            &quot;name&quot;: &quot;A String&quot;, # Required. Name of parameter.
            &quot;type&quot;: &quot;A String&quot;, # Type of parameter.
            &quot;typeSchema&quot;: { # Encapsulates different type schema variations: either a reference to an a schema that&#x27;s already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
              &quot;inlineSchema&quot;: { # A type schema object that&#x27;s specified inline. # Set if this is an inline schema definition.
                &quot;items&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
                &quot;type&quot;: &quot;A String&quot;, # Data type of the schema.
              },
              &quot;schemaReference&quot;: { # A reference to the schema of an existing tool. # Set if this is a schema reference.
                &quot;schema&quot;: &quot;A String&quot;, # The name of the schema.
                &quot;tool&quot;: &quot;A String&quot;, # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
              },
            },
          },
        ],
        &quot;instruction&quot;: { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
          &quot;guidelines&quot;: &quot;A String&quot;, # General guidelines for the playbook. These are unstructured instructions that are not directly part of the goal, e.g. &quot;Always be polite&quot;. It&#x27;s valid for this text to be long and used instead of steps altogether.
          &quot;steps&quot;: [ # Ordered list of step by step execution instructions to accomplish target goal.
            { # Message of single step execution.
              &quot;steps&quot;: [ # Sub-processing needed to execute the current step.
                # Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
              ],
              &quot;text&quot;: &quot;A String&quot;, # Step instruction in text format.
            },
          ],
        },
        &quot;llmModelSettings&quot;: { # Settings for LLM models. # Optional. Llm model settings for the playbook.
          &quot;model&quot;: &quot;A String&quot;, # The selected LLM model.
          &quot;parameters&quot;: { # Generative model parameters to control the model behavior. # Generative model parameters.
            &quot;inputTokenLimit&quot;: &quot;A String&quot;, # The input token limit. This setting is currently only supported by playbooks.
            &quot;outputTokenLimit&quot;: &quot;A String&quot;, # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set.
            &quot;temperature&quot;: 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0]
          },
          &quot;promptText&quot;: &quot;A String&quot;, # The custom prompt to use.
        },
        &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
        &quot;outputParameterDefinitions&quot;: [ # Optional. Defined structured output parameters for this playbook.
          { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
            &quot;description&quot;: &quot;A String&quot;, # Human-readable description of the parameter. Limited to 300 characters.
            &quot;name&quot;: &quot;A String&quot;, # Required. Name of parameter.
            &quot;type&quot;: &quot;A String&quot;, # Type of parameter.
            &quot;typeSchema&quot;: { # Encapsulates different type schema variations: either a reference to an a schema that&#x27;s already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
              &quot;inlineSchema&quot;: { # A type schema object that&#x27;s specified inline. # Set if this is an inline schema definition.
                &quot;items&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
                &quot;type&quot;: &quot;A String&quot;, # Data type of the schema.
              },
              &quot;schemaReference&quot;: { # A reference to the schema of an existing tool. # Set if this is a schema reference.
                &quot;schema&quot;: &quot;A String&quot;, # The name of the schema.
                &quot;tool&quot;: &quot;A String&quot;, # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
              },
            },
          },
        ],
        &quot;playbookType&quot;: &quot;A String&quot;, # Optional. Type of the playbook.
        &quot;referencedFlows&quot;: [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
          &quot;A String&quot;,
        ],
        &quot;referencedPlaybooks&quot;: [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
          &quot;A String&quot;,
        ],
        &quot;referencedTools&quot;: [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
          &quot;A String&quot;,
        ],
        &quot;speechSettings&quot;: { # Define behaviors of speech to text detection. # Optional. Playbook level Settings for speech to text detection.
          &quot;endpointerSensitivity&quot;: 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
          &quot;models&quot;: { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
            &quot;a_key&quot;: &quot;A String&quot;,
          },
          &quot;noSpeechTimeout&quot;: &quot;A String&quot;, # Timeout before detecting no speech.
          &quot;useTimeoutBasedEndpointing&quot;: True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
        },
        &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
        &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the playbook version was updated.
      },
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the playbook version was created or modified.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="restore">restore(name, body=None, x__xgafv=None)</code>
  <pre>Retrieves the specified version of the Playbook and stores it as the current playbook draft, returning the playbook with resources updated.

Args:
  name: string, Required. The name of the playbook version. Format: `projects//locations//agents//playbooks//versions/`. (required)
  body: object, The request body.
    The object takes the form of:

{ # The request message for Playbooks.RestorePlaybookVersion.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for Playbooks.RestorePlaybookVersion.
  &quot;playbook&quot;: { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # The updated playbook.
    &quot;codeBlock&quot;: { # Represents a code block. # Optional. The playbook&#x27;s scoped code block, which may implement handlers and actions.
      &quot;code&quot;: &quot;A String&quot;, # Optional. Source code of the block in Python.
    },
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp of initial playbook creation.
    &quot;displayName&quot;: &quot;A String&quot;, # Required. The human-readable name of the playbook, unique within an agent.
    &quot;goal&quot;: &quot;A String&quot;, # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it&#x27;s visible to other playbooks that may reference this playbook.
    &quot;handlers&quot;: [ # Optional. A list of registered handlers to execute based on the specified triggers.
      { # Handler can be used to define custom logic to be executed based on the user-specified triggers.
        &quot;eventHandler&quot;: { # A handler that is triggered by the specified event. # A handler triggered by event.
          &quot;condition&quot;: &quot;A String&quot;, # Optional. The condition that must be satisfied to trigger this handler.
          &quot;event&quot;: &quot;A String&quot;, # Required. The name of the event that triggers this handler.
          &quot;fulfillment&quot;: { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page&#x27;s entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to call when the event occurs.
            &quot;advancedSettings&quot;: { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent-&gt;Flow-&gt;Page-&gt;Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
              &quot;audioExportGcsDestination&quot;: { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
                &quot;uri&quot;: &quot;A String&quot;, # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
              },
              &quot;dtmfSettings&quot;: { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
                &quot;enabled&quot;: True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a &quot;3&quot; was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
                &quot;endpointingTimeoutDuration&quot;: &quot;A String&quot;, # Endpoint timeout setting for matching dtmf input to regex.
                &quot;finishDigit&quot;: &quot;A String&quot;, # The digit that terminates a DTMF digit sequence.
                &quot;interdigitTimeoutDuration&quot;: &quot;A String&quot;, # Interdigit timeout setting for matching dtmf input to regex.
                &quot;maxDigits&quot;: 42, # Max length of DTMF digits.
              },
              &quot;loggingSettings&quot;: { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
                &quot;enableConsentBasedRedaction&quot;: True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.
                &quot;enableInteractionLogging&quot;: True or False, # Enables DF Interaction logging.
                &quot;enableStackdriverLogging&quot;: True or False, # Enables Google Cloud Logging.
              },
              &quot;speechSettings&quot;: { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
                &quot;endpointerSensitivity&quot;: 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
                &quot;models&quot;: { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;noSpeechTimeout&quot;: &quot;A String&quot;, # Timeout before detecting no speech.
                &quot;useTimeoutBasedEndpointing&quot;: True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
              },
            },
            &quot;conditionalCases&quot;: [ # Conditional cases for this fulfillment.
              { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
                &quot;cases&quot;: [ # A list of cascading if-else conditions.
                  { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
                    &quot;caseContent&quot;: [ # A list of case content.
                      { # The list of messages or conditional cases to activate for this case.
                        &quot;additionalCases&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
                        &quot;message&quot;: { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message.
                          &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                          &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                            &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                          },
                          &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                          },
                          &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                          },
                          &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                            &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                          },
                          &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                            &quot;segments&quot;: [ # Segments this audio response is composed of.
                              { # Represents one segment of audio.
                                &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                                &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                                &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                              },
                            ],
                          },
                          &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                            &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                          },
                          &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                          },
                          &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                          },
                          &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                            &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                          },
                          &quot;text&quot;: { # The text response message. # Returns a text response.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                              &quot;A String&quot;,
                            ],
                          },
                          &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                            &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                            &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                            &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                          },
                        },
                      },
                    ],
                    &quot;condition&quot;: &quot;A String&quot;, # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
                  },
                ],
              },
            ],
            &quot;enableGenerativeFallback&quot;: True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
            &quot;generators&quot;: [ # A list of Generators to be called during this fulfillment.
              { # Generator settings used by the LLM to generate a text response.
                &quot;generator&quot;: &quot;A String&quot;, # Required. The generator to call. Format: `projects//locations//agents//generators/`.
                &quot;inputParameters&quot;: { # Map from placeholder parameter in the Generator to corresponding session parameters. By default, Dialogflow uses the session parameter with the same name to fill in the generator template. e.g. If there is a placeholder parameter `city` in the Generator, Dialogflow default to fill in the `$city` with `$session.params.city`. However, you may choose to fill `$city` with `$session.params.desination-city`. - Map key: parameter ID - Map value: session parameter name
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;outputParameter&quot;: &quot;A String&quot;, # Required. Output parameter which should contain the generator response.
              },
            ],
            &quot;messages&quot;: [ # The list of rich message responses to present to the user.
              { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.
                &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                  &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                },
                &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                },
                &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                },
                &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                  &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                },
                &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                  &quot;segments&quot;: [ # Segments this audio response is composed of.
                    { # Represents one segment of audio.
                      &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                      &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                      &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                    },
                  ],
                },
                &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                  &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                },
                &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                },
                &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                  &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                },
                &quot;text&quot;: { # The text response message. # Returns a text response.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                    &quot;A String&quot;,
                  ],
                },
                &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                  &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                  &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                  &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                },
              },
            ],
            &quot;returnPartialResponses&quot;: True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
            &quot;setParameterActions&quot;: [ # Set parameter values before executing the webhook.
              { # Setting a parameter value.
                &quot;parameter&quot;: &quot;A String&quot;, # Display name of the parameter.
                &quot;value&quot;: &quot;&quot;, # The new value of the parameter. A null value clears the parameter.
              },
            ],
            &quot;tag&quot;: &quot;A String&quot;, # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
            &quot;webhook&quot;: &quot;A String&quot;, # The webhook to call. Format: `projects//locations//agents//webhooks/`.
          },
        },
        &quot;lifecycleHandler&quot;: { # A handler that is triggered on the specific lifecycle_stage of the playbook execution. # A handler triggered during specific lifecycle of the playbook execution.
          &quot;condition&quot;: &quot;A String&quot;, # Optional. The condition that must be satisfied to trigger this handler.
          &quot;fulfillment&quot;: { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page&#x27;s entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # Required. The fulfillment to call when this handler is triggered.
            &quot;advancedSettings&quot;: { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent-&gt;Flow-&gt;Page-&gt;Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level.
              &quot;audioExportGcsDestination&quot;: { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level
                &quot;uri&quot;: &quot;A String&quot;, # Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: `gs://bucket/object-name-or-prefix` Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.
              },
              &quot;dtmfSettings&quot;: { # Define behaviors for DTMF (dual tone multi frequency). # Settings for DTMF. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level.
                &quot;enabled&quot;: True or False, # If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a &quot;3&quot; was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
                &quot;endpointingTimeoutDuration&quot;: &quot;A String&quot;, # Endpoint timeout setting for matching dtmf input to regex.
                &quot;finishDigit&quot;: &quot;A String&quot;, # The digit that terminates a DTMF digit sequence.
                &quot;interdigitTimeoutDuration&quot;: &quot;A String&quot;, # Interdigit timeout setting for matching dtmf input to regex.
                &quot;maxDigits&quot;: 42, # Max length of DTMF digits.
              },
              &quot;loggingSettings&quot;: { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level.
                &quot;enableConsentBasedRedaction&quot;: True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.
                &quot;enableInteractionLogging&quot;: True or False, # Enables DF Interaction logging.
                &quot;enableStackdriverLogging&quot;: True or False, # Enables Google Cloud Logging.
              },
              &quot;speechSettings&quot;: { # Define behaviors of speech to text detection. # Settings for speech to text detection. Exposed at the following levels: - Agent level - Flow level - Page level - Parameter level
                &quot;endpointerSensitivity&quot;: 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
                &quot;models&quot;: { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;noSpeechTimeout&quot;: &quot;A String&quot;, # Timeout before detecting no speech.
                &quot;useTimeoutBasedEndpointing&quot;: True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
              },
            },
            &quot;conditionalCases&quot;: [ # Conditional cases for this fulfillment.
              { # A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.
                &quot;cases&quot;: [ # A list of cascading if-else conditions.
                  { # Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.
                    &quot;caseContent&quot;: [ # A list of case content.
                      { # The list of messages or conditional cases to activate for this case.
                        &quot;additionalCases&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases # Additional cases to be evaluated.
                        &quot;message&quot;: { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard. # Returned message.
                          &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                          &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                            &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                          },
                          &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                          },
                          &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                          },
                          &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                            &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                          },
                          &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                            &quot;segments&quot;: [ # Segments this audio response is composed of.
                              { # Represents one segment of audio.
                                &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                                &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                                &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                              },
                            ],
                          },
                          &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                            &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                          },
                          &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                          },
                          &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                          },
                          &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                            &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                          },
                          &quot;text&quot;: { # The text response message. # Returns a text response.
                            &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                            &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                              &quot;A String&quot;,
                            ],
                          },
                          &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                            &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                            &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                            },
                            &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                          },
                        },
                      },
                    ],
                    &quot;condition&quot;: &quot;A String&quot;, # The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
                  },
                ],
              },
            ],
            &quot;enableGenerativeFallback&quot;: True or False, # If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses in the fulfillment will be respected. This flag is only useful for fulfillments associated with no-match event handlers.
            &quot;generators&quot;: [ # A list of Generators to be called during this fulfillment.
              { # Generator settings used by the LLM to generate a text response.
                &quot;generator&quot;: &quot;A String&quot;, # Required. The generator to call. Format: `projects//locations//agents//generators/`.
                &quot;inputParameters&quot;: { # Map from placeholder parameter in the Generator to corresponding session parameters. By default, Dialogflow uses the session parameter with the same name to fill in the generator template. e.g. If there is a placeholder parameter `city` in the Generator, Dialogflow default to fill in the `$city` with `$session.params.city`. However, you may choose to fill `$city` with `$session.params.desination-city`. - Map key: parameter ID - Map value: session parameter name
                  &quot;a_key&quot;: &quot;A String&quot;,
                },
                &quot;outputParameter&quot;: &quot;A String&quot;, # Required. Output parameter which should contain the generator response.
              },
            ],
            &quot;messages&quot;: [ # The list of rich message responses to present to the user.
              { # Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.
                &quot;channel&quot;: &quot;A String&quot;, # The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.
                &quot;conversationSuccess&quot;: { # Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn&#x27;t process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don&#x27;t return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue. # Indicates that the conversation succeeded.
                  &quot;metadata&quot;: { # Custom metadata. Dialogflow doesn&#x27;t impose any structure on this.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                },
                &quot;endInteraction&quot;: { # Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It&#x27;s guaranteed that there is at most one such message in each response.
                },
                &quot;knowledgeInfoCard&quot;: { # Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. # Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
                },
                &quot;liveAgentHandoff&quot;: { # Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a human agent.
                  &quot;metadata&quot;: { # Custom metadata for your handoff procedure. Dialogflow doesn&#x27;t impose any structure on this.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                },
                &quot;mixedAudio&quot;: { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user. # Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
                  &quot;segments&quot;: [ # Segments this audio response is composed of.
                    { # Represents one segment of audio.
                      &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this segment can be interrupted by the end user&#x27;s speech and the client should then start the next Dialogflow request.
                      &quot;audio&quot;: &quot;A String&quot;, # Raw audio synthesized from the Dialogflow agent&#x27;s response using the output config specified in the request.
                      &quot;uri&quot;: &quot;A String&quot;, # Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.
                    },
                  ],
                },
                &quot;outputAudioText&quot;: { # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. # A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;ssml&quot;: &quot;A String&quot;, # The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).
                  &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
                },
                &quot;payload&quot;: { # Returns a response containing a custom, platform-specific payload.
                  &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                },
                &quot;playAudio&quot;: { # Specifies an audio clip to be played by the client as part of the response. # Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;audioUri&quot;: &quot;A String&quot;, # Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.
                },
                &quot;telephonyTransferCall&quot;: { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
                  &quot;phoneNumber&quot;: &quot;A String&quot;, # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).
                },
                &quot;text&quot;: { # The text response message. # Returns a text response.
                  &quot;allowPlaybackInterruption&quot;: True or False, # Output only. Whether the playback of this message can be interrupted by the end user&#x27;s speech and the client can then starts the next Dialogflow request.
                  &quot;text&quot;: [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.
                    &quot;A String&quot;,
                  ],
                },
                &quot;toolCall&quot;: { # Represents a call of a specific tool&#x27;s action with the specified inputs. # Returns the definition of a tool call that should be executed by the client.
                  &quot;action&quot;: &quot;A String&quot;, # Required. The name of the tool&#x27;s action associated with this call.
                  &quot;inputParameters&quot;: { # Optional. The action&#x27;s input parameters.
                    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
                  },
                  &quot;tool&quot;: &quot;A String&quot;, # Required. The tool associated with this call. Format: `projects//locations//agents//tools/`.
                },
              },
            ],
            &quot;returnPartialResponses&quot;: True or False, # Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs. If a webhook is specified, it happens before Dialogflow invokes webhook. Warning: 1) This flag only affects streaming API. Responses are still queued and returned once in non-streaming API. 2) The flag can be enabled in any fulfillment but only the first 3 partial responses will be returned. You may only want to apply it to fulfillments that have slow webhooks.
            &quot;setParameterActions&quot;: [ # Set parameter values before executing the webhook.
              { # Setting a parameter value.
                &quot;parameter&quot;: &quot;A String&quot;, # Display name of the parameter.
                &quot;value&quot;: &quot;&quot;, # The new value of the parameter. A null value clears the parameter.
              },
            ],
            &quot;tag&quot;: &quot;A String&quot;, # The value of this field will be populated in the WebhookRequest `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is called. The tag is typically used by the webhook service to identify which fulfillment is being called, but it could be used for other purposes. This field is required if `webhook` is specified.
            &quot;webhook&quot;: &quot;A String&quot;, # The webhook to call. Format: `projects//locations//agents//webhooks/`.
          },
          &quot;lifecycleStage&quot;: &quot;A String&quot;, # Required. The name of the lifecycle stage that triggers this handler. Supported values: * `playbook-start` * `pre-action-selection` * `pre-action-execution`
        },
      },
    ],
    &quot;inlineActions&quot;: [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook&#x27;s code block.
      &quot;A String&quot;,
    ],
    &quot;inputParameterDefinitions&quot;: [ # Optional. Defined structured input parameters for this playbook.
      { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
        &quot;description&quot;: &quot;A String&quot;, # Human-readable description of the parameter. Limited to 300 characters.
        &quot;name&quot;: &quot;A String&quot;, # Required. Name of parameter.
        &quot;type&quot;: &quot;A String&quot;, # Type of parameter.
        &quot;typeSchema&quot;: { # Encapsulates different type schema variations: either a reference to an a schema that&#x27;s already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
          &quot;inlineSchema&quot;: { # A type schema object that&#x27;s specified inline. # Set if this is an inline schema definition.
            &quot;items&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
            &quot;type&quot;: &quot;A String&quot;, # Data type of the schema.
          },
          &quot;schemaReference&quot;: { # A reference to the schema of an existing tool. # Set if this is a schema reference.
            &quot;schema&quot;: &quot;A String&quot;, # The name of the schema.
            &quot;tool&quot;: &quot;A String&quot;, # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
          },
        },
      },
    ],
    &quot;instruction&quot;: { # Message of the Instruction of the playbook. # Instruction to accomplish target goal.
      &quot;guidelines&quot;: &quot;A String&quot;, # General guidelines for the playbook. These are unstructured instructions that are not directly part of the goal, e.g. &quot;Always be polite&quot;. It&#x27;s valid for this text to be long and used instead of steps altogether.
      &quot;steps&quot;: [ # Ordered list of step by step execution instructions to accomplish target goal.
        { # Message of single step execution.
          &quot;steps&quot;: [ # Sub-processing needed to execute the current step.
            # Object with schema name: GoogleCloudDialogflowCxV3beta1PlaybookStep
          ],
          &quot;text&quot;: &quot;A String&quot;, # Step instruction in text format.
        },
      ],
    },
    &quot;llmModelSettings&quot;: { # Settings for LLM models. # Optional. Llm model settings for the playbook.
      &quot;model&quot;: &quot;A String&quot;, # The selected LLM model.
      &quot;parameters&quot;: { # Generative model parameters to control the model behavior. # Generative model parameters.
        &quot;inputTokenLimit&quot;: &quot;A String&quot;, # The input token limit. This setting is currently only supported by playbooks.
        &quot;outputTokenLimit&quot;: &quot;A String&quot;, # The output token limit. This setting is currently only supported by playbooks. Only one of output_token_limit and max_output_tokens is allowed to be set.
        &quot;temperature&quot;: 3.14, # The temperature used for sampling during response generation. Value ranges from 0 to 1. Temperature controls the degree of randomness in token selection. Lower temperature means less randomness, while higher temperature means more randomness. Valid range: [0.0, 1.0]
      },
      &quot;promptText&quot;: &quot;A String&quot;, # The custom prompt to use.
    },
    &quot;name&quot;: &quot;A String&quot;, # The unique identifier of the playbook. Format: `projects//locations//agents//playbooks/`.
    &quot;outputParameterDefinitions&quot;: [ # Optional. Defined structured output parameters for this playbook.
      { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
        &quot;description&quot;: &quot;A String&quot;, # Human-readable description of the parameter. Limited to 300 characters.
        &quot;name&quot;: &quot;A String&quot;, # Required. Name of parameter.
        &quot;type&quot;: &quot;A String&quot;, # Type of parameter.
        &quot;typeSchema&quot;: { # Encapsulates different type schema variations: either a reference to an a schema that&#x27;s already defined by a tool, or an inline definition. # Optional. Type schema of parameter.
          &quot;inlineSchema&quot;: { # A type schema object that&#x27;s specified inline. # Set if this is an inline schema definition.
            &quot;items&quot;: # Object with schema name: GoogleCloudDialogflowCxV3beta1TypeSchema # Schema of the elements if this is an ARRAY type.
            &quot;type&quot;: &quot;A String&quot;, # Data type of the schema.
          },
          &quot;schemaReference&quot;: { # A reference to the schema of an existing tool. # Set if this is a schema reference.
            &quot;schema&quot;: &quot;A String&quot;, # The name of the schema.
            &quot;tool&quot;: &quot;A String&quot;, # The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.
          },
        },
      },
    ],
    &quot;playbookType&quot;: &quot;A String&quot;, # Optional. Type of the playbook.
    &quot;referencedFlows&quot;: [ # Output only. The resource name of flows referenced by the current playbook in the instructions.
      &quot;A String&quot;,
    ],
    &quot;referencedPlaybooks&quot;: [ # Output only. The resource name of other playbooks referenced by the current playbook in the instructions.
      &quot;A String&quot;,
    ],
    &quot;referencedTools&quot;: [ # Optional. The resource name of tools referenced by the current playbook in the instructions. If not provided explicitly, they are will be implied using the tool being referenced in goal and steps.
      &quot;A String&quot;,
    ],
    &quot;speechSettings&quot;: { # Define behaviors of speech to text detection. # Optional. Playbook level Settings for speech to text detection.
      &quot;endpointerSensitivity&quot;: 42, # Sensitivity of the speech model that detects the end of speech. Scale from 0 to 100.
      &quot;models&quot;: { # Mapping from language to Speech-to-Text model. The mapped Speech-to-Text model will be selected for requests from its corresponding language. For more information, see [Speech models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;noSpeechTimeout&quot;: &quot;A String&quot;, # Timeout before detecting no speech.
      &quot;useTimeoutBasedEndpointing&quot;: True or False, # Use timeout based endpointing, interpreting endpointer sensitivity as seconds of timeout value.
    },
    &quot;tokenCount&quot;: &quot;A String&quot;, # Output only. Estimated number of tokes current playbook takes when sent to the LLM.
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Last time the playbook version was updated.
  },
}</pre>
</div>

</body></html>